Top Fields Constructors Methods
org.aspectj.weaver.patterns

public Class DeclareParents

extends Declare
Class Inheritance
Known Direct Subclasses
org.aspectj.weaver.patterns.DeclareParentsMixin
Imports
java.io.IOException, java.util.ArrayList, .Collections, .Iterator, .List, .Map, org.aspectj.bridge.IMessage, .ISourceLocation, .Message, org.aspectj.weaver.CompressingDataOutputStream, .ISourceContext, .ResolvedType, .UnresolvedType, .VersionedDataInputStream, .WeaverMessages, .World

Authors
Thomas Kiviaho, Andy Clement, PARC

Field Summary

Modifier and TypeField and Description
protected TypePattern
protected boolean
private boolean
protected TypePatternList
Inherited from org.aspectj.weaver.patterns.Declare:
ANNOTATIONDOMINATESERROR_OR_WARNINGPARENTSPARENTSMIXINSOFTTYPE_ERROR_OR_WARNING

Constructor Summary

AccessConstructor and Description
public
DeclareParents(TypePattern child, List<TypePattern> parents, boolean isExtends)

protected
DeclareParents(TypePattern child, TypePatternList parents, boolean isExtends)

Method Summary

Modifier and TypeMethod and Description
public Object
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public List<ResolvedType>
findMatchingNewParents(ResolvedType onType, boolean reportErrors)

public TypePattern
public String
getNameSuffix()

Implements abstract org.aspectj.weaver.patterns.Declare.getNameSuffix.

Declares have methods in the .class file against which info can be stored (for example, the annotation in the case of declare annotation).
public TypePatternList
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isAdviceLike()

Implements abstract org.aspectj.weaver.patterns.Declare.isAdviceLike.

Indicates if this declare should be treated like advice.
public boolean
public boolean
public boolean
private ResolvedType
maybeGetNewParent(ResolvedType targetType, TypePattern typePattern, World world, boolean reportErrors)

public Declare
parameterizeWith(Map<String, UnresolvedType> typeVariableBindingMap, World w)

Implements abstract org.aspectj.weaver.patterns.Declare.parameterizeWith.

Returns a version of this declare element in which all references to type variables are replaced with their bindings given in the map.
public boolean
public boolean
public static Declare
public void
resolve(IScope scope)

Implements abstract org.aspectj.weaver.patterns.Declare.resolve.

Returns this declare mutated
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public Object
private boolean
verifyNoInheritedAlternateParameterization(ResolvedType typeToVerify, ResolvedType newParent, World world)

This method looks through the type hierarchy for some target type - it is attempting to find an existing parameterization that clashes with the new parent that the user wants to apply to the type.

public void
Inherited from org.aspectj.weaver.patterns.Declare:
getDeclaringTypesetDeclaringType

Field Detail

childback to summary
protected TypePattern child
isExtendsback to summary
protected boolean isExtends
isWildChildback to summary
private boolean isWildChild
parentsback to summary
protected TypePatternList parents

Constructor Detail

DeclareParentsback to summary
public DeclareParents(TypePattern child, List<TypePattern> parents, boolean isExtends)
DeclareParentsback to summary
protected DeclareParents(TypePattern child, TypePatternList parents, boolean isExtends)

Method Detail

acceptback to summary
public Object accept(PatternNodeVisitor visitor, Object data)

Implements abstract org.aspectj.weaver.patterns.PatternNode.accept.

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
findMatchingNewParentsback to summary
public List<ResolvedType> findMatchingNewParents(ResolvedType onType, boolean reportErrors)
getChildback to summary
public TypePattern getChild()
getNameSuffixback to summary
public String getNameSuffix()

Implements abstract org.aspectj.weaver.patterns.Declare.getNameSuffix.

Doc from org.aspectj.weaver.patterns.Declare.getNameSuffix.

Declares have methods in the .class file against which info can be stored (for example, the annotation in the case of declare annotation). The name is of the form ajc$declare_XXX_NNN where XXX can optionally be set in this 'getNameSuffix()' method - depending on whether, at weave time, we want to easily differentiate between the declare methods.

Annotations
@Override
getParentsback to summary
public TypePatternList getParents()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
isAdviceLikeback to summary
public boolean isAdviceLike()

Implements abstract org.aspectj.weaver.patterns.Declare.isAdviceLike.

Doc from org.aspectj.weaver.patterns.Declare.isAdviceLike.

Indicates if this declare should be treated like advice. If true, the declare will have no effect in an abstract aspect. It will be inherited by any concrete aspects and will have an effect for each concrete aspect it is ultimately inherited by.

Annotations
@Override
isExtendsback to summary
public boolean isExtends()
isMixinback to summary
public boolean isMixin()
matchback to summary
public boolean match(ResolvedType typeX)
maybeGetNewParentback to summary
private ResolvedType maybeGetNewParent(ResolvedType targetType, TypePattern typePattern, World world, boolean reportErrors)
parameterizeWithback to summary
public Declare parameterizeWith(Map<String, UnresolvedType> typeVariableBindingMap, World w)

Implements abstract org.aspectj.weaver.patterns.Declare.parameterizeWith.

Doc from org.aspectj.weaver.patterns.Declare.parameterizeWith.

Returns a version of this declare element in which all references to type variables are replaced with their bindings given in the map.

Annotations
@Override
parentsIncludeClassback to summary
public boolean parentsIncludeClass(World w)
parentsIncludeInterfaceback to summary
public boolean parentsIncludeInterface(World w)
readback to summary
public static Declare read(VersionedDataInputStream s, ISourceContext context) throws IOException

Hides org.aspectj.weaver.patterns.Declare.read.

resolveback to summary
public void resolve(IScope scope)

Implements abstract org.aspectj.weaver.patterns.Declare.resolve.

Doc from org.aspectj.weaver.patterns.Declare.resolve.

Returns this declare mutated

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
traverseback to summary
public Object traverse(PatternNodeVisitor visitor, Object data)

Overrides org.aspectj.weaver.patterns.PatternNode.traverse.

verifyNoInheritedAlternateParameterizationback to summary
private boolean verifyNoInheritedAlternateParameterization(ResolvedType typeToVerify, ResolvedType newParent, World world)

This method looks through the type hierarchy for some target type - it is attempting to find an existing parameterization that clashes with the new parent that the user wants to apply to the type. If it finds an existing parameterization that matches the new one, it silently completes, if it finds one that clashes (e.g. a type already has A when the user wants to add A) then it will produce an error. It uses recursion and exits recursion on hitting 'jlObject' Related bugzilla entries: pr110788

writeback to summary
public void write(CompressingDataOutputStream s) throws IOException

Implements abstract org.aspectj.weaver.patterns.PatternNode.write.

Annotations
@Override