Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MNEMONIC-831: Enhanced Code Documentation #391

Merged
merged 1 commit into from
Jun 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,44 +18,92 @@

import org.apache.mnemonic.DurableType;

/**
* This class represents information about an attribute, including its name,
* type, sort order, and entity field ID.
*/
public class AttributeInfo {

// The name of the attribute
private String name;

// The type of the attribute, represented by a DurableType
private DurableType type;

// The sort order of the attribute
private SortOrder sortOrder;

// The ID of the entity field associated with this attribute
private long entityFieldId;

/**
* Gets the name of the attribute.
*
* @return the name of the attribute
*/
public String getName() {
return name;
}

/**
* Sets the name of the attribute.
*
* @param name the new name of the attribute
*/
public void setName(String name) {
this.name = name;
}

/**
* Gets the sort order of the attribute.
*
* @return the sort order of the attribute
*/
public SortOrder getSortOrder() {
return sortOrder;
}

/**
* Sets the sort order of the attribute.
*
* @param sortOrder the new sort order of the attribute
*/
public void setSortOrder(SortOrder sortOrder) {
this.sortOrder = sortOrder;
}

/**
* Gets the type of the attribute.
*
* @return the type of the attribute
*/
public DurableType getType() {
return type;
}

/**
* Sets the type of the attribute.
*
* @param type the new type of the attribute
*/
public void setType(DurableType type) {
this.type = type;
}

/**
* Gets the entity field ID associated with the attribute.
*
* @return the entity field ID
*/
public long getEntityFieldId() {
return entityFieldId;
}

/**
* Sets the entity field ID associated with the attribute.
*
* @param entityFieldId the new entity field ID
*/
public void setEntityFieldId(long entityFieldId) {
this.entityFieldId = entityFieldId;
}
Expand Down
Loading