com.togethersoft.openapi.sci
Interface SciElement

All Known Subinterfaces:

SciAccessor, SciAttribute, SciClass, SciCompoundMember, SciDelegate, SciFunction, SciInheritance, SciInitializer, SciMember, SciOperation, SciParameter, SciThrowSpecifier, SciVariable

public interface SciElement

extends SciObject

A generic element of a program (class, function, variable,
and so on).
Each SCI
element has a set of characteristics that define its behavior and structure:

Properties

Properties contain an element's modifier-like information. For example, an element can have a property
that indicates whether this element is private. An element can have several properties.

Unique Name

Each SCI element has a string with special content called unique name.
This string is totally unique within the SCI model,
and every element can be found or identified by its unique name.

Qualified Name

Qualified name makes sense only for SciClasses and
SciMembers, and contains the full name of the element.
For example, the qualified name for a java class will look like a standard Java language
fully qualified class name: "java.lang.String".

You can identify a class by its qualified name if you know its language. For example:



SciClass justFoundClass = mySciModel.findClass(SciLanguage.JAVA,"com.togethersoft.openapi.sci.SciElement");




Name

A string containing a short name of the element. For example, the short name of
"java.lang.String" is "String".

Every derivative of an SciElement inherits the accept(SciElementVisitor) method, which
runs a visitor's visitXXX method corresponding to the kind of element.

visitReferences(SciReferenceVisitor) and
visitReferences(SciReferenceVisitor, SciElement) methods are used to perform
actions on references contained in this element.

These interfaces contain a very useful method getTagList, which gives access to the
SciTag objects representing RWI properties of this element, written in Javadoc
style in the comment field.

The isDeleted method is used for checking whether this SciElement
represents an existing element of the model.

Author:

TogetherSoft

Since: Together 3.0

See Also: SciProperty, SciTag, SciElementVisitor, SciReferenceVisitor

Method Detail

accept

public Object accept(SciElementVisitor visitor)

"Accepts" a visitor, calling up its visitXXX method corresponding to the kind of element.

Parameters:

visitor the SciElementVisitor type visitor

Returns: visitor-specific result.

See Also:

SciElementVisitor, com.togethersoft.openapi.sci.visitor

public boolean canSetName(String name)

Checks whether the specified name can be set for this element.

Parameters:

name the string which needs to be assigned as a name fot this element

Returns: true if the specified name can be set for this element, false otherwise

public boolean canSetProperty(int property, boolean value)

Checks if the value is valid for this property, or can be assigned to it at this time.

Parameters:

property The integer value which represents a kind of property.
See SciProperty interface for predefined kinds of properties.

value the boolean value for the property

Returns: true if the value can be assigned to the property, false otherwise

See Also:

SciProperty

public String getDeclarationText()

Returns a string with a text of this element's declaration.
For example, for the SciMember
representing this Java operation:

/**

* @author TogetherSoft Corporation

*/

public void someOperation(String str){

System.out.println(str);

}

this method returns "public void someOperation(String str)".

Returns: a string

public String getName()

Returns a string containing the name for this element.

Returns: a string containing the name for this element

public String getQualifiedName()

Returns a string with the qualified name of this element.
For SciClass the qualified name is a fully qualified name of this class.

For SciMembers this method returns a string written in Together's internal format.
To obtain a normal string with the member's qualified name, the method
SciLanguageHelper.convertMemberQualifiedNameToPresentableForm
can be used.

Returns: a string with the qualified name of this element

See Also:

SciModel.findClass(java.lang.String,java.lang.String), SciModel.findMember(java.lang.String,java.lang.String)

public SciTagList getTagList()

Returns SciTagList object containing all SciTags for this element.
SciTag with the name null provides access to the description part of the comment.

Returns: SciTagList object containing all SciTags for this element

See Also:

SciTagList

public String getUniqueName()

Returns a string with the unique name of this element.

Returns: a string with the unique name of this element

See Also:

SciModel.findElement(java.lang.String)

public boolean hasProperty(int property)

Checks whether this element has the specified property. Returns true if it does,
false otherwise.

Parameters:

property The integer value which represents a kind of property.
See SciProperty interface for predefined kinds of properties.

Returns: true if this element has the specified property, false otherwise.

For example, suppose we have SciClass. SciClass might represent either a
class or an interface. Here is how we can distinguish them:

if (someSciClass.hasProperty(SciProperty.INTERFACE)){

... // it is an interface

} else {

... // it is a class

}

Another example: suppose you have SciOperation and you need to know if it is a
public abstract operation:

if (someSciOperation.hasProperty(SciProperty.PUBLIC) && someSciOperation.hasProperty(SciProperty.ABSTRACT)){

... // it is a public abstract operation

} else {

... // it is something else, not public abstract

}

See Also:

SciProperty

public boolean isDeleted()

Checks whether this SciElement represents existing model data. For example, if you have gotten
a SciElement representing an operation, and after that (while your script or pattern was
passive) the user deleted this operation in the text editor (or your script deleted SciObject
representing this operation via SciObject.delete method, or the user just
closed the project), then your SciElement
will refer to a non-existing element.

If you try to use methods of a deleted SciElement, the result is unpredictable
(you might get a NullPointerException, and so on). You should always check whether
SciElement is deleted, if you are not sure about it:

if (!mySciElement.isDeleted()) {

return mySciElement.getPositions();

} 

Since Together version 5.1, implementation of SciClass was changed in order to return last valid
value at calls to SciObject.getLanguage(), SciElement.getQualifiedName(),
SciElement().getUniqueName() when isDeleted() returns true.

The only exception is methods equals and hashCode which can be performed
on deleted elements as well.

Returns: true if this SciElement represents a non-existing model element
and cannot be used any longer, false otherwise

public boolean isPropertyReadable(int property)

Checks whether the property is readable (used to check whether the property has a sense for this element).

Parameters:

property The integer value which represents a kind of property.
See SciProperty interface for predefined kinds of properties.

Returns: true if the property is readable, false otherwise

See Also:

SciProperty

public boolean isPropertyWritable(int property)

Checks whether the property is writable for this element.

Parameters:

property The integer value which represents a kind of property.
See SciProperty interface for predefined kinds of properties.

Returns: true if the property is writable, false otherwise

See Also:

SciProperty

public void setName(String name)

Sets the name for this element.

Parameters:

name the string which needs to be assigned as a name to this element

public void setProperty(int property, boolean value)

Sets the value for the property.

Parameters:

property The integer value that represents a kind of property.
See SciProperty interface for predefined kinds of properties.

value the boolean value for the property

For example, if you have SciOperation representing a public operation and you would like
to make it private:

if (someSciOperation.canSetProperty(SciProperty.PRIVATE, true)){

someSciOperation.setProperty(SciProperty.PRIVATE, true); //do it

}

See Also:

SciProperty

public void visitReferences(SciReferenceVisitor visitor)

In this element, makes a specified visitor perform certain actions on all references.

Parameters:

visitor the SciReferenceVisitor which will perform certain actions
upon all references in this element

See Also:

SciReferenceVisitor

public void visitReferences(SciReferenceVisitor visitor, SciElement referencedElement)

In this element, makes a specified visitor perform certain actions on all references to the specified
element.

Parameters:

visitor the SciReferenceVisitor which will perform certain actions
upon all references to the specified element

referencedElement the SciElement, references to which are subject to the actions

See Also:

SciReferenceVisitor