Package org.ek9lang.compiler.symbols

Class AggregateWithTraitsSymbol

java.lang.Object

org.ek9lang.compiler.symbols.Symbol

org.ek9lang.compiler.symbols.ScopedSymbol

org.ek9lang.compiler.symbols.CaptureScopedSymbol

org.ek9lang.compiler.symbols.PossibleGenericSymbol

org.ek9lang.compiler.symbols.AggregateSymbol

org.ek9lang.compiler.symbols.AggregateWithTraitsSymbol

All Implemented Interfaces:

Serializable, IAggregateSymbol, ICanBeGeneric, ICanCaptureVariables, IScope, IScopedSymbol, ISymbol, ITokenReference

public class AggregateWithTraitsSymbol
extends AggregateSymbol

An aggregate, but one that can have zero or more traits (like interfaces).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.ek9lang.compiler.symbols.IScope

IScope.ScopeType

Nested classes/interfaces inherited from interface org.ek9lang.compiler.symbols.ISymbol

ISymbol.SymbolCategory, ISymbol.SymbolGenus

Field Summary

Fields inherited from interface org.ek9lang.compiler.symbols.ISymbol

NOT_ASSIGNABLE

Constructor Summary

Constructors

Constructor	Description
AggregateWithTraitsSymbol(String name, Optional<ISymbol> type, IScope enclosingScope)
AggregateWithTraitsSymbol(String name, IScope enclosingScope)

Method Summary

Modifier and Type	Method	Description
void	addAllowedExtender(IAggregateSymbol extenderSymbol)	For use with constraining types to be limited to a declared set.
void	addTrait(AggregateWithTraitsSymbol traitSymbol)	mark this aggregate as having additional 'trait'.
AggregateWithTraitsSymbol	clone(IScope withParentAsAppropriate)	Clone the symbol and re-parent if this symbol like a method should have a parent.
protected AggregateWithTraitsSymbol	cloneIntoAggregateWithTraitsSymbol(AggregateWithTraitsSymbol newCopy)
boolean	equals(Object o)
List<MethodSymbol>	getAllAbstractMethods()	Gets all abstract methods in this aggregate and any super classes.
List<AggregateWithTraitsSymbol>	getAllExtensionConstrainedTraits()	Gets all traits this class implements directly or indirectly through supers that have constraints upon them.
List<MethodSymbol>	getAllMethods()	Get all methods on this and any supers or traits.
List<MethodSymbol>	getAllNonAbstractMethods()	Get all methods not marked as abstract in this or any supers.
List<IAggregateSymbol>	getAllowedExtenders()
List<ISymbol>	getAllSymbolsMatchingName(String symbolName)	Return a list of all the symbols that match the name.
List<AggregateWithTraitsSymbol>	getAllTraits()	Get all the traits this aggregate implements - this means all the traits any of these traits extends.
double	getAssignableWeightTo(ISymbol s)
List<IAggregateSymbol>	getTraits()	Get the traits that this aggregates implements.
double	getUnCoercedAssignableWeightTo(ISymbol s)
int	hashCode()
boolean	hasImmediateTrait(IAggregateSymbol trait)	Does this aggregate have the trait passed in as an immediate trait.
boolean	isAllowingExtensionBy(IAggregateSymbol extenderSymbol)	Is the extender allowed to implement this aggregate (normally a trait).
boolean	isExtensionConstrained()
boolean	isImplementingInSomeWay(IAggregateSymbol traitSymbol)	Only really used by aggregates that can have one or more traits.
MethodSymbolSearchResult	resolveMatchingMethods(MethodSymbolSearch search, MethodSymbolSearchResult result)	Looks in scope and parent scopes.
Optional<ISymbol>	resolveMember(SymbolSearch search)	Just try and resolve a member in this or super scopes.
Optional<ISymbol>	resolveWithParentScope(SymbolSearch search)	Resolve using super aggregate and or any traits we have.

Methods inherited from class org.ek9lang.compiler.symbols.AggregateSymbol

addSubAggregateSymbol, addTraitsIfNotPresent, cloneIntoAggregateSymbol, define, getAggregateDescription, getAllAbstractMethodsInThisScopeOnly, getAllMethodInThisScopeOnly, getAllNonAbstractMethodsInThisScopeOnly, getAllOperators, getAnySuperTypeOrFunction, getConstructors, getFriendlyName, getPipeSinkType, getPipeSourceType, getProperties, getSubAggregateSymbols, getSuperAggregate, getType, hasImmediateSuper, isExtensionOfInjectable, isInAggregateHierarchy, isInjectable, isMarkedAsDispatcher, setAggregateDescription, setInjectable, setMarkedAsDispatcher, setName, setPipeSinkType, setPipeSourceType, setSuperAggregate, setSuperAggregate, setType

Methods inherited from class org.ek9lang.compiler.symbols.PossibleGenericSymbol

addGenericSymbolReference, addTypeParameterOrArgument, cloneIntoPossibleGenericSymbol, getAnyConceptualTypeParameters, getAnyGenericParamsAsFriendlyNames, getGenericSymbolReferences, getGenericType, getTypeParameterOrArguments, isConceptualTypeParameter, isGenericInNature, isOpenForExtension, isParameterisedType, resolve, resolveFromParameterTypes, resolveInThisScopeOnly, setConceptualTypeParameter, setGenericType, setGenericType, setOpenForExtension

Methods inherited from class org.ek9lang.compiler.symbols.CaptureScopedSymbol

cloneIntoCaptureScopedSymbol, getCapturedVariables, getModuleScope, getPrivateVariablesForDisplay, isMarkedAbstract, resolveExcludingCapturedVariables, setCapturedVariables, setCapturedVariables, setCapturedVariablesVisibility, setMarkedAbstract, setModuleScope

Methods inherited from class org.ek9lang.compiler.symbols.ScopedSymbol

cloneIntoScopeSymbol, copyScopedSymbolProperties, findNearestDynamicBlockScopeInEnclosingScopes, findNearestNonBlockScopeInEnclosingScopes, getActualScope, getEnclosingScope, getEncounteredExceptionToken, getFriendlyScopeName, getOuterMostTypeOrFunction, getScopeName, getScopeType, getSymbolsForThisScope, isMarkedPure, isMutable, isNotMarkedPure, isScopeAMatchForEnclosingScope, isTerminatedNormally, resolveMatchingMethodsInThisScopeOnly, setEncounteredExceptionToken, setMarkedPure, setOuterMostTypeOrFunction, setScopeType

Methods inherited from class org.ek9lang.compiler.symbols.Symbol

clearInitialisedBy, cloneIntoSymbol, copySymbolProperties, getAssignableWeightTo, getCategory, getFullyQualifiedName, getGenus, getInitialisedBy, getName, getParsedModule, getProduceFullyQualifiedName, getSourceToken, getSquirrelledData, getSymbolTypeAsString, isAssignableTo, isAssignableTo, isDevSource, isEk9Core, isExactSameType, isInjectionExpected, isLibSource, isNullAllowed, isPromotionSupported, isReferenced, putSquirrelledData, setCategory, setEk9Core, setGenus, setInitialisedBy, setInjectionExpected, setNotMutable, setNullAllowed, setParsedModule, setProduceFullyQualifiedName, setReferenced, setSourceToken, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ek9lang.compiler.symbols.IAggregateSymbol

getName, getScopeType

Methods inherited from interface org.ek9lang.compiler.symbols.ICanBeGeneric

addGenericSymbolReference, addTypeParameterOrArgument, getAnyConceptualTypeParameters, getGenericSymbolReferences, getGenericType, getTypeParameterOrArguments, isOpenForExtension

Methods inherited from interface org.ek9lang.compiler.symbols.IScope

findNearestDynamicBlockScopeInEnclosingScopes, findNearestNonBlockScopeInEnclosingScopes, getEnclosingScope, getEncounteredExceptionToken, getFriendlyScopeName, getScopeName, getSymbolsForThisScope, isMarkedPure, isScopeAMatchForEnclosingScope, isTerminatedNormally, resolve, resolveInThisScopeOnly, resolveMatchingMethodsInThisScopeOnly, setEncounteredExceptionToken

Methods inherited from interface org.ek9lang.compiler.symbols.ISymbol

clearInitialisedBy, getAssignableWeightTo, getCategory, getFullyQualifiedName, getGenus, getInitialisedBy, getParsedModule, getSourceToken, getSquirrelledData, isApplication, isAssignableTo, isAssignableTo, isConceptualTypeParameter, isConstant, isControl, isDeclaredAsConstant, isDevSource, isEk9Core, isExactSameType, isFromLiteral, isFunction, isGenericInNature, isIncomingParameter, isInitialised, isInjectionExpected, isLibSource, isLoopVariable, isMarkedAbstract, isMarkedPure, isMethod, isMutable, isNullAllowed, isParameterisedType, isPrimitiveType, isPrivate, isPromotionSupported, isPropertyField, isProtected, isPublic, isReferenced, isReturningParameter, isTemplateFunction, isTemplateType, isType, isVariable, putSquirrelledData, setGenus, setInitialisedBy, setInjectionExpected, setNotMutable, setNullAllowed, setParsedModule, setReferenced, setType

Methods inherited from interface org.ek9lang.compiler.symbols.ITokenReference

setSourceToken

Constructor Details

AggregateWithTraitsSymbol

public AggregateWithTraitsSymbol(String name,
 IScope enclosingScope)

AggregateWithTraitsSymbol

public AggregateWithTraitsSymbol(String name,
 Optional<ISymbol> type,
 IScope enclosingScope)

Method Details

cloneIntoAggregateWithTraitsSymbol

protected AggregateWithTraitsSymbol cloneIntoAggregateWithTraitsSymbol(AggregateWithTraitsSymbol newCopy)

addTrait

public void addTrait(AggregateWithTraitsSymbol traitSymbol)

mark this aggregate as having additional 'trait'.

hasImmediateTrait

public boolean hasImmediateTrait(IAggregateSymbol trait)

Does this aggregate have the trait passed in as an immediate trait. i.e. one it implements itself. Note this is different from being compatible with the trait via hierarchy!

Parameters:

trait - The trait to check.

Returns:

true if it does false otherwise.

addAllowedExtender

public void addAllowedExtender(IAggregateSymbol extenderSymbol)

For use with constraining types to be limited to a declared set.

getAllowedExtenders

public List<IAggregateSymbol> getAllowedExtenders()

isAllowingExtensionBy

public boolean isAllowingExtensionBy(IAggregateSymbol extenderSymbol)

Is the extender allowed to implement this aggregate (normally a trait).

Parameters:

extenderSymbol - The class (normally the one we are testing)

Returns:

true if extending is allowed.

getAllSymbolsMatchingName

public List<ISymbol> getAllSymbolsMatchingName(String symbolName)

Description copied from interface: IScope

Return a list of all the symbols that match the name. So for class and traits this must include supers and traits.

Specified by:

getAllSymbolsMatchingName in interface IScope

Overrides:

getAllSymbolsMatchingName in class AggregateSymbol

clone

public AggregateWithTraitsSymbol clone(IScope withParentAsAppropriate)

Description copied from interface: ISymbol

Clone the symbol and re-parent if this symbol like a method should have a parent. Other symbols like VariableSymbols are un-parented

Specified by:

clone in interface IAggregateSymbol

Specified by:

clone in interface IScope

Specified by:

clone in interface IScopedSymbol

Specified by:

clone in interface ISymbol

Overrides:

clone in class AggregateSymbol

getUnCoercedAssignableWeightTo

public double getUnCoercedAssignableWeightTo(ISymbol s)

Specified by:

getUnCoercedAssignableWeightTo in interface ISymbol

Overrides:

getUnCoercedAssignableWeightTo in class AggregateSymbol

getAssignableWeightTo

public double getAssignableWeightTo(ISymbol s)

Specified by:

getAssignableWeightTo in interface ISymbol

Overrides:

getAssignableWeightTo in class Symbol

isImplementingInSomeWay

public boolean isImplementingInSomeWay(IAggregateSymbol traitSymbol)

Description copied from interface: IAggregateSymbol

Only really used by aggregates that can have one or more traits. But also super classes or super traits. So can either be implementing directly, super, super - super or traits and supe traits.

Specified by:

isImplementingInSomeWay in interface IAggregateSymbol

Overrides:

isImplementingInSomeWay in class AggregateSymbol

getTraits

public List<IAggregateSymbol> getTraits()

Get the traits that this aggregates implements.

Returns:

The list of traits.

getAllExtensionConstrainedTraits

public List<AggregateWithTraitsSymbol> getAllExtensionConstrainedTraits()

Gets all traits this class implements directly or indirectly through supers that have constraints upon them. The list of constraining traits - no implication or check on what they are constrained to - that's up to the caller.

getAllTraits

public List<AggregateWithTraitsSymbol> getAllTraits()

Get all the traits this aggregate implements - this means all the traits any of these traits extends. But also going up the class supers and getting those traits and any of the traits they extend.

Specified by:

getAllTraits in interface IAggregateSymbol

Overrides:

getAllTraits in class AggregateSymbol

getAllMethods

public List<MethodSymbol> getAllMethods()

Description copied from interface: IAggregateSymbol

Get all methods on this and any supers or traits.

Specified by:

getAllMethods in interface IAggregateSymbol

Overrides:

getAllMethods in class AggregateSymbol

Returns:

the list

getAllAbstractMethods

public List<MethodSymbol> getAllAbstractMethods()

Gets all abstract methods in this aggregate and any super classes.

Specified by:

getAllAbstractMethods in interface IAggregateSymbol

Overrides:

getAllAbstractMethods in class AggregateSymbol

Returns:

A list of all the methods marked as abstract.

isExtensionConstrained

public boolean isExtensionConstrained()

getAllNonAbstractMethods

public List<MethodSymbol> getAllNonAbstractMethods()

Description copied from interface: IAggregateSymbol

Get all methods not marked as abstract in this or any supers.

Specified by:

getAllNonAbstractMethods in interface IAggregateSymbol

Overrides:

getAllNonAbstractMethods in class AggregateSymbol

Returns:

The list.

resolveMatchingMethods

public MethodSymbolSearchResult resolveMatchingMethods(MethodSymbolSearch search,
 MethodSymbolSearchResult result)

Description copied from interface: IScope

Looks in scope and parent scopes.

Specified by:

resolveMatchingMethods in interface IAggregateSymbol

Specified by:

resolveMatchingMethods in interface IScope

Overrides:

resolveMatchingMethods in class AggregateSymbol

resolveMember

public Optional<ISymbol> resolveMember(SymbolSearch search)

Description copied from class: AggregateSymbol

Just try and resolve a member in this or super scopes.

Specified by:

resolveMember in interface IAggregateSymbol

Specified by:

resolveMember in interface IScope

Overrides:

resolveMember in class AggregateSymbol

resolveWithParentScope

public Optional<ISymbol> resolveWithParentScope(SymbolSearch search)

Resolve using super aggregate and or any traits we have. Look in our traits first then go to the normal AggregateSymbol resolution.

Overrides:

resolveWithParentScope in class ScopedSymbol

equals

public boolean equals(Object o)

Overrides:

equals in class AggregateSymbol

hashCode

public int hashCode()

Overrides:

hashCode in class AggregateSymbol