org.eclipse.ocl.examples.codegen.cgmodel
Interface CGValuedElement

All Superinterfaces:

CGElement, CGNamedElement, CGTypedElement, org.eclipse.emf.ecore.EObject, Nameable, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

CGAccumulator, CGAssertNonNullExp, CGASTCallExp, CGBoolean, CGBoxExp, CGBuiltInIterationCallExp, CGCallable, CGCallExp, CGCastExp, CGCatchExp, CGCollectionExp, CGCollectionPart, CGConstant, CGConstantExp, CGConstraint, CGConstructorExp, CGConstructorPart, CGContainmentBody, CGContainmentPart, CGContainmentVisit, CGEcoreClassConstructorExp, CGEcoreDataTypeConstructorExp, CGEcoreOperation, CGEcoreOperationCallExp, CGEcoreOppositePropertyCallExp, CGEcorePropertyCallExp, CGElementId, CGExecutorCompositionProperty, CGExecutorConstructorPart, CGExecutorNavigationProperty, CGExecutorOperation, CGExecutorOperationCallExp, CGExecutorOppositeProperty, CGExecutorOppositePropertyCallExp, CGExecutorProperty, CGExecutorPropertyCallExp, CGExecutorType, CGFinalVariable, CGGuardExp, CGIfExp, CGInteger, CGInvalid, CGIsEqualExp, CGIsInvalidExp, CGIsUndefinedExp, CGIterationCallExp, CGIterator, CGLetExp, CGLibraryIterateCallExp, CGLibraryIterationCallExp, CGLibraryOperation, CGLibraryOperationCallExp, CGLibraryPropertyCallExp, CGLocalVariable, CGNavigationCallExp, CGNull, CGNumber, CGOperation, CGOperationCallExp, CGOppositePropertyCallExp, CGParameter, CGProperty, CGPropertyCallExp, CGReal, CGSettableVariable, CGString, CGText, CGTextParameter, CGThrowExp, CGTupleExp, CGTuplePart, CGTuplePartCallExp, CGTypeExp, CGTypeId, CGUnboxExp, CGUnlimited, CGVariable, CGVariableExp

All Known Implementing Classes:

CGAccumulatorImpl, CGAssertNonNullExpImpl, CGASTCallExpImpl, CGBooleanImpl, CGBoxExpImpl, CGBuiltInIterationCallExpImpl, CGCallableImpl, CGCallExpImpl, CGCastExpImpl, CGCatchExpImpl, CGCollectionExpImpl, CGCollectionPartImpl, CGConstantExpImpl, CGConstantImpl, CGConstraintImpl, CGConstructorExpImpl, CGConstructorPartImpl, CGContainmentBodyImpl, CGContainmentPartImpl, CGContainmentVisitImpl, CGEcoreClassConstructorExpImpl, CGEcoreDataTypeConstructorExpImpl, CGEcoreOperationCallExpImpl, CGEcoreOperationImpl, CGEcoreOppositePropertyCallExpImpl, CGEcorePropertyCallExpImpl, CGElementIdImpl, CGExecutorCompositionPropertyImpl, CGExecutorConstructorPartImpl, CGExecutorNavigationPropertyImpl, CGExecutorOperationCallExpImpl, CGExecutorOperationImpl, CGExecutorOppositePropertyCallExpImpl, CGExecutorOppositePropertyImpl, CGExecutorPropertyCallExpImpl, CGExecutorPropertyImpl, CGExecutorTypeImpl, CGFinalVariableImpl, CGGuardExpImpl, CGIfExpImpl, CGIntegerImpl, CGInvalidImpl, CGIsEqualExpImpl, CGIsInvalidExpImpl, CGIsUndefinedExpImpl, CGIterationCallExpImpl, CGIteratorImpl, CGLetExpImpl, CGLibraryIterateCallExpImpl, CGLibraryIterationCallExpImpl, CGLibraryOperationCallExpImpl, CGLibraryOperationImpl, CGLibraryPropertyCallExpImpl, CGLocalVariableImpl, CGNavigationCallExpImpl, CGNullImpl, CGNumberImpl, CGOperationCallExpImpl, CGOperationImpl, CGOppositePropertyCallExpImpl, CGParameterImpl, CGPropertyCallExpImpl, CGPropertyImpl, CGRealImpl, CGSettableVariableImpl, CGStringImpl, CGTextImpl, CGTextParameterImpl, CGThrowExpImpl, CGTupleExpImpl, CGTuplePartCallExpImpl, CGTuplePartImpl, CGTypeExpImpl, CGTypeIdImpl, CGUnboxExpImpl, CGUnlimitedImpl, CGValuedElementImpl, CGVariableExpImpl, CGVariableImpl

public interface CGValuedElement
extends CGTypedElement

A representation of the model object 'CG Valued Element'.

The following features are supported:

• Depends On
• Owns

See Also:

CGModelPackage.getCGValuedElement()

Generated

Method Summary

java.util.List<CGValuedElement>	getDependsOn() Returns the value of the 'Depends On' reference list.
CGInvalid	getInvalidValue() Return a non-null invalid value if this value is invalid.
CGValuedElement	getNamedValue() Return the CGValuedElement that provides the name of a declaration from which the value of this CGValuedElement may be obtained.
java.util.List<CGValuedElement>	getOwns() Returns the value of the 'Owns' containment reference list.
CGValuedElement	getReferredValue() Return the CGValuedElement to which the value of this CGValuedElement delegates.
CGValuedElement	getSourceValue() Return the CGValuedElement which is the source of the information value of this element.
CGValuedElement	getThisValue() Return a simpler CGValuedElement that is fully equivalent to this element.
CGValuedElement	getTypedValue() Return the CGValuedElement that provides the narrowest type declaration from which the type of this CGValuedElement may be obtained.
java.lang.String	getValueName() Return the declared name value of this element.
boolean	isAssertedNonNull() Return true if this value is not null, possibly with the aid of an assertion.
boolean	isBoxed() Return true if this value is a boxed value.
boolean	isCaught() Returns true if any exception associated with this value has been caught and consequently the value may be an InvalidValueException.
boolean	isCommonable() Return true if this value can be shared as part of a Common Subexpression.
boolean	isConstant() Return true if this value is a local constant (dependent of the user type system).
java.lang.Boolean	isEquivalentTo(CGValuedElement thatValue) Returns true/false if this value can be determined to have deep value equivalence/inequivalence to thatValue, null if no determination can be made.
java.lang.Boolean	isEquivalentToInternal(CGValuedElement thatValue) Provided that thatValue does not delegate its equivalence computation, return true/false if this value can be determined to have deep value equivalence/inequivalence to thatValue, null if no determination can be made.
boolean	isFalse() Return true if this value is false.
boolean	isGlobal() Return true if this value is a global constant (independent of the user type system).
boolean	isInlined() Return true if this value is inlined and so has no local or global declaration.
boolean	isInvalid() Return true if this value is false.
boolean	isNonInvalid() Return true if this value is false.
boolean	isNonNull() Return true if this value is not null.
boolean	isNull() Return true if this value is null.
boolean	isSettable() Return true if this value can be inlined as an expression term.
boolean	isTrue() Return true if this value is true.
boolean	isUnboxed() Return true if this value is an unboxed value.
boolean	isUncommonable() Return true if this value does not have to be shared as part of a Common Subexpression.
void	setCaught(boolean isCaught) Set the caught status.
void	setValueName(java.lang.String valueName) Set the name of the value.

Methods inherited from interface org.eclipse.ocl.examples.codegen.cgmodel.CGTypedElement

getASTypeId, getTypeId, isRequired, setRequired, setTypeId

Methods inherited from interface org.eclipse.ocl.examples.codegen.cgmodel.CGNamedElement

getAst, getName, setAst, setName

Methods inherited from interface org.eclipse.ocl.examples.codegen.cgmodel.CGElement

accept, getChildren, getParent, getPlace, isContext, rewriteAs

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getDependsOn

java.util.List<CGValuedElement> getDependsOn()

Returns the value of the 'Depends On' reference list. The list contents are of type CGValuedElement. The elements that must be declared before this element.

Returns:

the value of the 'Depends On' reference list.

See Also:

CGModelPackage.getCGValuedElement_DependsOn()

Generated

getOwns

java.util.List<CGValuedElement> getOwns()

Returns the value of the 'Owns' containment reference list. The list contents are of type CGValuedElement.

If the meaning of the 'Owns' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Owns' containment reference list.

See Also:

CGModelPackage.getCGValuedElement_Owns()

Generated

getInvalidValue

@Nullable
CGInvalid getInvalidValue()

Return a non-null invalid value if this value is invalid.

Generated

getNamedValue

@NonNull
CGValuedElement getNamedValue()

Return the CGValuedElement that provides the name of a declaration from which the value of this CGValuedElement may be obtained. Fundamental elements such as constants and operation calls provide the named value themselves. More complex elements such as VariableExp and ThrowExp may delegate.

Generated

getReferredValue

@NonNull
CGValuedElement getReferredValue()

Return the CGValuedElement to which the value of this CGValuedElement delegates. Fundamental elements such as constants and operation calls provide the named value themselves. More complex elements such as VariableExp and ThrowExp may delegate.

Generated

getSourceValue

@NonNull
CGValuedElement getSourceValue()

Return the CGValuedElement which is the source of the information value of this element. Note that the source value may be differently guarded, caught/thrown and boxed/unboxed to this value. Returns this if no delegation occurs.

Generated

getThisValue

@NonNull
CGValuedElement getThisValue()

Return a simpler CGValuedElement that is fully equivalent to this element. May return CGInvalid if this element is invalid. May return the internal value of a CollectionPart or TuplePart. May follow a delegation when the delegation has no semantic significance. Returns this if no simplification occurs.

Generated

getTypedValue

@NonNull
CGValuedElement getTypedValue()

Return the CGValuedElement that provides the narrowest type declaration from which the type of this CGValuedElement may be obtained. Fundamental elements such as constants and operations call provide their own narrow type. More complex elements such as CatchExp have a wide type that includes invalid and so delegate to identify the narrow type. More complex elements such as GuardExp/ThrowExp propagate an unchanged value with a narrower type than their source.

Generated

getValueName

@Nullable
java.lang.String getValueName()

Return the declared name value of this element. The text is valid for use in the target language and unique within the context in which this element is declared.

Generated

isAssertedNonNull

boolean isAssertedNonNull()

Return true if this value is not null, possibly with the aid of an assertion.

Generated

isBoxed

boolean isBoxed()

Return true if this value is a boxed value.

Generated

isCaught

boolean isCaught()

Returns true if any exception associated with this value has been caught and consequently the value may be an InvalidValueException. Returns true if any exception has been thrown.

Generated

isCommonable

boolean isCommonable()

Return true if this value can be shared as part of a Common Subexpression.

Generated

isConstant

boolean isConstant()

Return true if this value is a local constant (dependent of the user type system).

Generated

isEquivalentTo

@Nullable
java.lang.Boolean isEquivalentTo(@NonNull
                                          CGValuedElement thatValue)

Returns true/false if this value can be determined to have deep value equivalence/inequivalence to thatValue, null if no determination can be made.

Generated

isEquivalentToInternal

@Nullable
java.lang.Boolean isEquivalentToInternal(@NonNull
                                                  CGValuedElement thatValue)

Provided that thatValue does not delegate its equivalence computation, return true/false if this value can be determined to have deep value equivalence/inequivalence to thatValue, null if no determination can be made.

Generated

isFalse

boolean isFalse()

Return true if this value is false.

Generated

isGlobal

boolean isGlobal()

Return true if this value is a global constant (independent of the user type system).

Generated

isInlined

boolean isInlined()

Return true if this value is inlined and so has no local or global declaration.

Generated

isInvalid

boolean isInvalid()

Return true if this value is false.

Generated

isNonInvalid

boolean isNonInvalid()

Return true if this value is false.

Generated

isNonNull

boolean isNonNull()

Return true if this value is not null.

Generated

isNull

boolean isNull()

Return true if this value is null.

Generated

isSettable

boolean isSettable()

Return true if this value can be inlined as an expression term.

Generated

isTrue

boolean isTrue()

Return true if this value is true.

Generated

isUnboxed

boolean isUnboxed()

Return true if this value is an unboxed value.

Generated

isUncommonable

boolean isUncommonable()

Return true if this value does not have to be shared as part of a Common Subexpression.

Generated

setCaught

void setCaught(boolean isCaught)

Set the caught status.

Generated

setValueName

void setValueName(@NonNull
                  java.lang.String valueName)

Set the name of the value.

Generated