org.eclipse.mtj.core.symbol
Interface ISymbol
-
All Superinterfaces:
-
IPersistable
-
public interface ISymbol
- extends
IPersistable
A Symbol is a pair <name; value> and may be used for preprocessing
purposes.
Clients must use
MTJCore.getSymbolSetFactory()
to retrieve an
ISymbolSetFactory
instance and use the
ISymbolSetFactory.createSymbol(String, String)
to create an ISymbol
instance.
-
Since:
- 1.0
-
Restriction:
- This interface is not intended to be implemented by clients.
Field Summary
|
static int
|
TYPE_ABILITY
When a symbol represents an ability. |
static int
|
TYPE_RUNTIME
When a symbol represents an MTJRuntime ID. |
TYPE_ABILITY
static final int TYPE_ABILITY
- When a symbol represents an ability. For example, if a device is touch
screen or not.
-
See Also:
-
Constant Field Values
TYPE_RUNTIME
static final int TYPE_RUNTIME
- When a symbol represents an MTJRuntime ID.
-
See Also:
-
Constant Field Values
equals
boolean equals(
Object obj)
- If name equals, then symbol equals.
-
-
Overrides:
-
equals
in class
Object
-
-
Parameters:
-
obj
- the reference object with which to compare.
-
Returns:
-
true
if this object is the same as the obj argument;
false
otherwise.
getName
String getName()
- Return the name of the symbol.
-
-
-
Returns:
- the symbol name.
getSafeValue
String getSafeValue()
- Get value in safe format for preprocessor.
-
-
-
Returns:
- symbol value in safe format for preprocessor.
getType
int getType()
- Get the symbol type.
-
-
-
Returns:
- the symbol type. Possible types are
TYPE_ABILITY
and
TYPE_RUNTIME
.
getValue
String getValue()
- Return the symbol value.
-
-
-
Returns:
- the value of the symbol.
hashCode
int hashCode()
-
-
Overrides:
-
hashCode
in class
Object
-
setName
void setName(
String identifier)
- Sets the the name of the symbol.
-
-
-
Parameters:
-
identifier
- the name of the symbol. This is case-sensitive and must
not be null
or an empty String ""
.
setType
void setType(int type)
- Set the symbol type.
-
-
-
Parameters:
-
type
- the symbol type. Possible types are
TYPE_ABILITY
and
TYPE_RUNTIME
.
setValue
void setValue(
String value)
- Set the value of the symbol.
-
-
-
Parameters:
-
value
- the value of the symbol.
toString
String toString()
-
-
Overrides:
-
toString
in class
Object
-