Overview  Package   Class  Tree  Deprecated  Index  Help 
Lombok.ast - v0.2
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

lombok.ast
Class ClassDeclaration

java.lang.Object
  extended by lombok.ast.ClassDeclaration
All Implemented Interfaces:
DescribedNode, JavadocContainer, Node, Statement, TypeDeclaration, TypeMember
public class ClassDeclaration
extends Object
implements TypeMember, Statement, TypeDeclaration, JavadocContainer

Constructor Summary
ClassDeclaration()
           
 
Method Summary
 void accept(AstVisitor visitor)
           
 Node addMessage(Message message)
           
protected  lombok.ast.AbstractNode adopt(lombok.ast.AbstractNode child)
          Adopts (accepts as direct child) the provided node.
 NormalTypeBody astBody()
           
 ClassDeclaration astBody(NormalTypeBody body)
           
 TypeReference astExtending()
           
 ClassDeclaration astExtending(TypeReference extending)
           
 StrictListAccessor<TypeReference,ClassDeclaration> astImplementing()
           
 Comment astJavadoc()
           
 ClassDeclaration astJavadoc(Comment javadoc)
           
 Modifiers astModifiers()
           
 ClassDeclaration astModifiers(Modifiers modifiers)
           
 Identifier astName()
           
 ClassDeclaration astName(Identifier name)
           
 StrictListAccessor<TypeVariable,ClassDeclaration> astTypeVariables()
           
 ClassDeclaration copy()
           
 boolean detach(Node child)
          If the provided child node is a child of this node, the child/parent link will be deleted.
protected  void disown(lombok.ast.AbstractNode child)
          Disowns a direct child (it will be parentless after this call).
protected  void ensureParentage(lombok.ast.AbstractNode child)
          Checks if the provided node is a direct child of this node.
protected  void ensureParentless()
          Checks if this node is currently parentless.
 List<Node> getChildren()
           
 String getDescription()
          A very short string that is particularly useful in describing this node.
 Node getGeneratedBy()
          Returns the node that is responsible for generating this node.
 List<Message> getMessages()
           
 boolean hasMessage(String key)
           
 boolean hasParent()
           
 boolean isGenerated()
          Returns true if this node is generated (not actually present in the source).
 boolean isInterface()
           
 Node rawBody()
           
 ClassDeclaration rawBody(Node body)
           
 Node rawExtending()
           
 ClassDeclaration rawExtending(Node extending)
           
 RawListAccessor<TypeReference,ClassDeclaration> rawImplementing()
           
 Node rawJavadoc()
           
 ClassDeclaration rawJavadoc(Node javadoc)
           
 RawListAccessor<TypeVariable,ClassDeclaration> rawTypeVariables()
           
 boolean replace(Node replacement)
          Replaces this node with the replacement.
 boolean replaceChild(Node original, Node replacement)
          If the provided child node is a child of this node, the child/parent link will be deleted.
 Node setPosition(Position position)
           
 String toString()
           
 void unparent()
          Severs the child/parent link between this node and its parent.
 CompilationUnit upIfTopLevelToCompilationUnit()
           
 Block upToBlock()
           
 TypeBody upToTypeBody()
           
 TypeDeclaration upUpToTypeDeclaration()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface lombok.ast.Node
addMessage, getGeneratedBy, getMessages, getParent, getPosition, hasMessage, hasParent, isGenerated, replace, setPosition, toString, unparent
 

Constructor Detail

ClassDeclaration

public ClassDeclaration()
Method Detail

upToTypeBody

public TypeBody upToTypeBody()
Specified by:
upToTypeBody in interface TypeMember

upToBlock

public Block upToBlock()
Specified by:
upToBlock in interface Statement
Specified by:
upToBlock in interface TypeDeclaration

upIfTopLevelToCompilationUnit

public CompilationUnit upIfTopLevelToCompilationUnit()
Specified by:
upIfTopLevelToCompilationUnit in interface TypeDeclaration

astJavadoc

public Comment astJavadoc()
Specified by:
astJavadoc in interface JavadocContainer
Specified by:
astJavadoc in interface TypeDeclaration

astJavadoc

public ClassDeclaration astJavadoc(Comment javadoc)
Specified by:
astJavadoc in interface JavadocContainer
Specified by:
astJavadoc in interface TypeDeclaration

rawJavadoc

public Node rawJavadoc()
Specified by:
rawJavadoc in interface JavadocContainer
Specified by:
rawJavadoc in interface TypeDeclaration

rawJavadoc

public ClassDeclaration rawJavadoc(Node javadoc)
Specified by:
rawJavadoc in interface JavadocContainer
Specified by:
rawJavadoc in interface TypeDeclaration

astModifiers

public Modifiers astModifiers()
Specified by:
astModifiers in interface TypeDeclaration

astModifiers

public ClassDeclaration astModifiers(Modifiers modifiers)
Specified by:
astModifiers in interface TypeDeclaration

astName

public Identifier astName()
Specified by:
astName in interface TypeDeclaration

astName

public ClassDeclaration astName(Identifier name)
Specified by:
astName in interface TypeDeclaration

rawTypeVariables

public RawListAccessor<TypeVariable,ClassDeclaration> rawTypeVariables()

astTypeVariables

public StrictListAccessor<TypeVariable,ClassDeclaration> astTypeVariables()

astExtending

public TypeReference astExtending()

astExtending

public ClassDeclaration astExtending(TypeReference extending)

rawExtending

public Node rawExtending()

rawExtending

public ClassDeclaration rawExtending(Node extending)

rawImplementing

public RawListAccessor<TypeReference,ClassDeclaration> rawImplementing()

astImplementing

public StrictListAccessor<TypeReference,ClassDeclaration> astImplementing()

astBody

public NormalTypeBody astBody()
Specified by:
astBody in interface TypeDeclaration

astBody

public ClassDeclaration astBody(NormalTypeBody body)

rawBody

public Node rawBody()
Specified by:
rawBody in interface TypeDeclaration

rawBody

public ClassDeclaration rawBody(Node body)

getChildren

public List<Node> getChildren()
Specified by:
getChildren in interface Node

replaceChild

public boolean replaceChild(Node original,
                            Node replacement)
                     throws AstException
Description copied from interface: Node
If the provided child node is a child of this node, the child/parent link will be deleted. The replacement node, if it is non-null, will take its place, and a new child/parent link will be created between this node and the replacement.

Specified by:
replaceChild in interface Node
Returns:
true if child was indeed a direct child of this node (it will have been replaced).
Throws:
AstException - If the replacement is of the wrong type and the location for the replacement does not allow off-type assignments, which is true for those nodes that only have an astName() method and not a rawName() method.

detach

public boolean detach(Node child)
Description copied from interface: Node
If the provided child node is a child of this node, the child/parent link will be deleted. The child's parentage is set to unparented, and whichever property in this node is linking to the child is cleared. If child is not a child of this node, nothing happens.

Specified by:
detach in interface Node
Returns:
true if child was indeed a direct child of this node (it will have been detached).
See Also:
Node.unparent()

accept

public void accept(AstVisitor visitor)
Specified by:
accept in interface Node

copy

public ClassDeclaration copy()
Specified by:
copy in interface Node

getDescription

public String getDescription()
Description copied from interface: DescribedNode
A very short string that is particularly useful in describing this node. Can always be null to indicate this particular instance has no useful name (usually, but not neccessarily, because it is not valid). NB: This method should never throw an exception!

Specified by:
getDescription in interface DescribedNode

isInterface

public boolean isInterface()
Specified by:
isInterface in interface TypeDeclaration

upUpToTypeDeclaration

public TypeDeclaration upUpToTypeDeclaration()

isGenerated

public boolean isGenerated()
Description copied from interface: Node
Returns true if this node is generated (not actually present in the source).

Specified by:
isGenerated in interface Node

getGeneratedBy

public Node getGeneratedBy()
Description copied from interface: Node
Returns the node that is responsible for generating this node. Returns null if this node is not generated.

Specified by:
getGeneratedBy in interface Node

hasParent

public boolean hasParent()
Specified by:
hasParent in interface Node

replace

public boolean replace(Node replacement)
                throws AstException
Description copied from interface: Node
Replaces this node with the replacement.

Specified by:
replace in interface Node
Returns:
true if the node was indeed replaced. Replacement fails if this node has no parent.
Throws:
AstException - If the replacement is of the wrong type and the location for the replacement does not allow off-type assignments, which is true for those nodes that only have an astName() method and not a rawName() method.

unparent

public void unparent()
Description copied from interface: Node
Severs the child/parent link between this node and its parent. This node's parentage will be set to unparented, and whichever property in the parent node is linking to this node is cleared. If this node is already unparented nothing happens.

Specified by:
unparent in interface Node
See Also:
Node.detach(Node)

adopt

protected lombok.ast.AbstractNode adopt(lombok.ast.AbstractNode child)
                                 throws IllegalStateException
Adopts (accepts as direct child) the provided node.

Parameters:
child - The node to adopt
Returns:
The child parameter for chaining.
Throws:
IllegalStateException - If child already has a parent (clone or unparent it first).

ensureParentless

protected void ensureParentless()
                         throws IllegalStateException
Checks if this node is currently parentless.

Throws:
IllegalStateException - if I have a parent.

disown

protected void disown(lombok.ast.AbstractNode child)
               throws IllegalStateException
Disowns a direct child (it will be parentless after this call).

Parameters:
child - Child node to disown
Throws:
IllegalStateException - if child isn't a direct child of myself.

ensureParentage

protected void ensureParentage(lombok.ast.AbstractNode child)
                        throws IllegalStateException
Checks if the provided node is a direct child of this node.

Parameters:
child - This node must be a direct child of myself.
Throws:
IllegalStateException - If child isn't a direct child of myself.

setPosition

public Node setPosition(Position position)
Specified by:
setPosition in interface Node

toString

public String toString()
Specified by:
toString in interface Node
Overrides:
toString in class Object

addMessage

public Node addMessage(Message message)
Specified by:
addMessage in interface Node

hasMessage

public boolean hasMessage(String key)
Specified by:
hasMessage in interface Node

getMessages

public List<Message> getMessages()
Specified by:
getMessages in interface Node
Overview  Package   Class  Tree  Deprecated  Index  Help 
Lombok.ast - v0.2
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010-2011 The Project Lombok Authors, licensed under the MIT licence.