|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAbstractArtifact
Abstract Artifact for a Tigerstripe Model
Nested Class Summary | |
---|---|
static interface |
IAbstractArtifact.IFieldTypeRef
|
Field Summary |
---|
Fields inherited from interface org.eclipse.tigerstripe.model.IModelComponent |
---|
VISIBILITY_PACKAGE, VISIBILITY_PRIVATE, VISIBILITY_PROTECTED, VISIBILITY_PUBLIC |
Method Summary | |
---|---|
void |
addIField(IField field)
|
void |
addILabel(ILabel label)
|
void |
addIMethod(IMethod method)
|
java.lang.String |
asText()
|
void |
doSave(org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
|
void |
doSilentSave(org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
|
IAbstractArtifact[] |
getAncestors()
Returns the Ancestors of this class if defined. |
java.lang.String |
getArtifactPath()
|
java.lang.String |
getArtifactType()
|
java.lang.Object[] |
getChildren()
Returns all children for this artifact Children are Fields, Methods, Literals, and potentially ends for IRelationships |
IAbstractArtifact |
getExtendedIArtifact()
Returns the IArtifact which this artifact extends. |
IAbstractArtifact[] |
getExtendingArtifacts()
Returns an array of all the artifacts that extends this directly. |
IAbstractArtifact[] |
getExtendingIArtifacts()
Returns the list of artifacts that are extending "this" artifact. |
IAbstractArtifact.IFieldTypeRef[] |
getFieldITypes()
Returns an array of all the field types for this artifact. |
java.lang.String |
getFullyQualifiedName()
Returns the fully qualified name (ie. |
java.lang.String |
getIArtifactType()
Returns the type of this artifact. |
IField[] |
getIFields()
Returns the fields defined for this artifact |
IField[] |
getIFields(boolean filterFacetExcludedFields)
Returns the fields defined for this artifact. |
ILabel[] |
getILabels()
Returns the labels defined for this artifact |
ILabel[] |
getILabels(boolean filterFacetExcludedLabels)
Returns the labels defined for this artifact. |
IMethod[] |
getIMethods()
|
IMethod[] |
getIMethods(boolean filterFacetExcludedMethods)
Returns the methods defined for this artifact. |
IAbstractArtifact[] |
getImplementedArtifacts()
Returns an array containing all the artifacts that are implemented by this artifact; |
java.lang.String |
getImplementedArtifactsAsStr()
|
IAbstractArtifact[] |
getImplementingIArtifacts()
Returns an array containing all the artifacts that are implementing this. |
IField[] |
getInheritedIFields()
Returns the inherited fields for this artifact. |
IField[] |
getInheritedIFields(boolean filterFacetExcludedFields)
Returns the inherited fields for this artifact. |
ILabel[] |
getInheritedILabels()
Returns the inherited labels for this artifact. |
ILabel[] |
getInheritedILabels(boolean filterFacetExcludedLabels)
Returns the inherited labels for this artifact. |
IMethod[] |
getInheritedIMethods()
Returns the inherited methods for this artifact. |
IMethod[] |
getInheritedIMethods(boolean filterFacetExcludedMethods)
Returns the inherited methods for this artifact. |
ITigerstripeProject |
getIProject()
|
IProjectDescriptor |
getIProjectDescriptor()
Returns the details contained in the project that this artifact belongs to. |
org.eclipse.tigerstripe.internal.api.model.artifacts.ossj.IStandardSpecifics |
getIStandardSpecifics()
Returns the standard specific details for this artifact. |
ITigerstripeProject |
getITigerstripeProject()
Returns the project that contains this artifact. |
java.lang.String |
getLabel()
Returns the label for this Artifact Type that will be displayed in the GUI |
java.lang.String |
getPackage()
Returns the package where this artifact is defined. |
java.util.Collection<java.lang.String> |
getReferencedArtifacts()
|
IAbstractArtifact[] |
getReferencedIArtifacts()
Returns an array containing all the artifacts being referenced (through a reference or attribute) from this artifact. |
IAbstractArtifact[] |
getReferencingIArtifacts()
Returns an array with all the artifacts referencing this artifact. |
org.eclipse.tigerstripe.internal.api.model.artifacts.updater.IModelUpdater |
getUpdater()
Figures out the updater to use to submit IModelChangeRequests regarding this artifact. |
boolean |
hasExtends()
Returns true if this artifact extends another artifact. |
boolean |
isAbstract()
Returns true if this Artifact is marked as abstract. |
boolean |
isInActiveFacet()
Returns true if this artifact is part of the active facet, false otherwise. |
boolean |
isReadonly()
Returns true if this is a read-only artifact (i.e. |
IField |
makeIField()
Make a new blank artifact field |
ILabel |
makeILabel()
Make a new blank artifact label |
IMethod |
makeIMethod()
|
void |
removeIFields(IField[] fields)
|
void |
removeILabels(ILabel[] labels)
|
void |
removeIMethods(IMethod[] methods)
|
void |
setAbstract(boolean isAbstract)
Sets the value of the isAbstract flag for this. |
void |
setExtendedIArtifact(IAbstractArtifact artifact)
|
void |
setFullyQualifiedName(java.lang.String fqn)
|
void |
setIFields(IField[] fields)
Sets the fields for this Abstract Artifact |
void |
setILabels(ILabel[] labels)
Sets the labels for this Abstract Artifact |
void |
setIMethods(IMethod[] methods)
|
void |
setImplementedArtifacts(IAbstractArtifact[] artifacts)
|
void |
setPackage(java.lang.String packageName)
|
java.util.List<org.eclipse.tigerstripe.internal.api.utils.TigerstripeError> |
validate()
|
void |
write(java.io.Writer writer)
|
Methods inherited from interface org.eclipse.tigerstripe.model.IModelComponent |
---|
addStereotypeInstance, getComment, getName, getVisibility, removeStereotypeInstance, removeStereotypeInstances, setComment, setName, setVisibility |
Methods inherited from interface org.eclipse.tigerstripe.profile.stereotype.IStereotypeCapable |
---|
getStereotypeInstances |
Method Detail |
---|
void setFullyQualifiedName(java.lang.String fqn)
void setPackage(java.lang.String packageName)
IField[] getIFields()
IField makeIField()
void setIFields(IField[] fields)
fields
-
java.lang.IllegalArgumentException
void addIField(IField field)
void removeIFields(IField[] fields)
ILabel[] getILabels()
ILabel makeILabel()
void setILabels(ILabel[] labels)
labels
-
java.lang.IllegalArgumentException
void addILabel(ILabel label)
void removeILabels(ILabel[] labels)
IMethod[] getIMethods()
IMethod makeIMethod()
void setIMethods(IMethod[] methods)
void addIMethod(IMethod method)
void removeIMethods(IMethod[] methods)
void setExtendedIArtifact(IAbstractArtifact artifact)
void doSave(org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor) throws TigerstripeException
TigerstripeException
void doSilentSave(org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor) throws TigerstripeException
TigerstripeException
java.util.List<org.eclipse.tigerstripe.internal.api.utils.TigerstripeError> validate()
void write(java.io.Writer writer) throws TigerstripeException
TigerstripeException
java.lang.String asText() throws TigerstripeException
TigerstripeException
ITigerstripeProject getIProject()
java.lang.String getArtifactType()
void setAbstract(boolean isAbstract)
isAbstract
- boolean isReadonly()
java.lang.String getLabel()
IAbstractArtifact getExtendedIArtifact()
IAbstractArtifact[] getExtendingArtifacts()
java.lang.Object[] getChildren()
boolean isInActiveFacet() throws TigerstripeException
isInActiveFacet
in interface IModelComponent
TigerstripeException
java.lang.String getImplementedArtifactsAsStr()
void setImplementedArtifacts(IAbstractArtifact[] artifacts)
java.lang.String getArtifactPath() throws TigerstripeException
TigerstripeException
org.eclipse.tigerstripe.internal.api.model.artifacts.updater.IModelUpdater getUpdater() throws TigerstripeException
TigerstripeException
IAbstractArtifact[] getAncestors()
IAbstractArtifact[] getExtendingIArtifacts()
IAbstractArtifact.IFieldTypeRef[] getFieldITypes()
java.lang.String getFullyQualifiedName()
java.lang.String getIArtifactType()
IField[] getIFields(boolean filterFacetExcludedFields)
filterFacetExcludedFields
- -
if set to true, all fields that are excluded by the active
facet will be filtered out. If no facet is active, all fields
are returned.
getInheritedIFields()
ILabel[] getILabels(boolean filterFacetExcludedLabels)
filterFacetExcludedLabels
- -
if set to true, all labels that are excluded by the active
facet will be filtered out. If no facet is active, all labels
are returned.
getInheritedILabels()
IMethod[] getIMethods(boolean filterFacetExcludedMethods)
filterFacetExcludedMethods
- -
if set to true, all methods that are excluded by the active
facet will be filtered out. If no facet is active, all methods
are returned.
getInheritedIMethods()
IProjectDescriptor getIProjectDescriptor()
#IextTigerstripeProject()
which returns null for artifacts
contained in Modules.
org.eclipse.tigerstripe.internal.api.model.artifacts.ossj.IStandardSpecifics getIStandardSpecifics()
IAbstractArtifact[] getImplementedArtifacts()
IAbstractArtifact[] getImplementingIArtifacts()
IField[] getInheritedIFields()
IField[] getInheritedIFields(boolean filterFacetExcludedFields)
filterFacetExcludedFields
- -
if set to true, all fields that are excluded by the active
facet will be filtered out. If no facet is active, all fields
are returned.
ILabel[] getInheritedILabels()
ILabel[] getInheritedILabels(boolean filterFacetExcludedLabels)
filterFacetExcludedLabels
- -
if set to true, all labels that are excluded by the active
facet will be filtered out. If no facet is active, all labels
are returned.
IMethod[] getInheritedIMethods()
IMethod[] getInheritedIMethods(boolean filterFacetExcludedMethods)
filterFacetExcludedMethods
- -
if set to true, all methods that are excluded by the active
facet will be filtered out. If no facet is active, all methods
are returned.
ITigerstripeProject getITigerstripeProject()
getIProjectDescriptor()
java.lang.String getPackage()
java.util.Collection<java.lang.String> getReferencedArtifacts()
IAbstractArtifact[] getReferencedIArtifacts()
IAbstractArtifact[] getReferencingIArtifacts()
boolean hasExtends()
boolean isAbstract()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |