Package org.sonar.php.tree.impl.declaration

Class ClassDeclarationTreeImpl

java.lang.Object

org.sonar.php.tree.impl.PHPTree

org.sonar.php.tree.impl.declaration.ClassDeclarationTreeImpl

All Implemented Interfaces:

HasClassSymbol, ClassDeclarationTree, ClassTree, HasAttributes, StatementTree, Tree

Direct Known Subclasses:

EnumDeclarationTreeImpl

public class ClassDeclarationTreeImpl
extends PHPTree
implements ClassDeclarationTree, HasClassSymbol

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.plugins.php.api.tree.Tree

Tree.Kind

Field Summary

Fields inherited from interface org.sonar.plugins.php.api.tree.declaration.ClassTree

PHP5_CONSTRUCTOR_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClassDeclarationTreeImpl(Tree.Kind kind, List<AttributeGroupTree> attributeGroups, List<SyntaxToken> modifiersToken, SyntaxToken classEntryTypeToken, NameIdentifierTree name, SyntaxToken extendsToken, NamespaceNameTree superClass, SyntaxToken implementsToken, SeparatedListImpl<NamespaceNameTree> superInterfaces, SyntaxToken openCurlyBraceToken, List<ClassMemberTree> members, SyntaxToken closeCurlyBraceToken)

Method Summary

Modifier and Type	Method	Description
void	accept(VisitorCheck visitor)
List<AttributeGroupTree>	attributeGroups()
Iterator<Tree>	childrenIterator()	Creates iterator for children of this node.
SyntaxToken	classToken()	Either class, trait, interface or enum
SyntaxToken	closeCurlyBraceToken()
static ClassDeclarationTree	createClass(List<AttributeGroupTree> attributes, List<SyntaxToken> modifiersToken, InternalSyntaxToken classToken, NameIdentifierTree name, InternalSyntaxToken extendsToken, NamespaceNameTree superClass, InternalSyntaxToken implementsToken, SeparatedListImpl<NamespaceNameTree> superInterfaces, InternalSyntaxToken openCurlyBraceToken, List<ClassMemberTree> members, InternalSyntaxToken closeCurlyBraceToken)
static ClassDeclarationTree	createInterface(List<AttributeGroupTree> attributes, InternalSyntaxToken interfaceToken, NameIdentifierTree name, InternalSyntaxToken extendsToken, SeparatedListImpl<NamespaceNameTree> interfaceList, InternalSyntaxToken openCurlyBraceToken, List<ClassMemberTree> members, InternalSyntaxToken closeCurlyBraceToken)
static ClassDeclarationTree	createTrait(List<AttributeGroupTree> attributes, InternalSyntaxToken traitToken, NameIdentifierTree name, InternalSyntaxToken openCurlyBraceToken, List<ClassMemberTree> members, InternalSyntaxToken closeCurlyBraceToken)
SyntaxToken	extendsToken()
MethodDeclarationTree	fetchConstructor()	Fetch class constructor declaration within class members.
Tree.Kind	getKind()
SyntaxToken	implementsToken()
boolean	isAbstract()
boolean	isFinal()
boolean	isReadOnly()
List<ClassMemberTree>	members()
List<SyntaxToken>	modifiersToken()	Contain modifier tokens : abstract, final and/or readonly
SyntaxToken	modifierToken()	Either abstract or final
NameIdentifierTree	name()
SyntaxToken	openCurlyBraceToken()
void	setSymbol(ClassSymbol symbol)
NamespaceNameTree	superClass()
SeparatedListImpl<NamespaceNameTree>	superInterfaces()
ClassSymbol	symbol()

Methods inherited from class org.sonar.php.tree.impl.PHPTree

getFirstToken, getLastToken, getLine, getParent, is, isLeaf, setParent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sonar.plugins.php.api.tree.Tree

getParent, is

Constructor Details

ClassDeclarationTreeImpl

protected ClassDeclarationTreeImpl(Tree.Kind kind,
 List<AttributeGroupTree> attributeGroups,
 List<SyntaxToken> modifiersToken,
 SyntaxToken classEntryTypeToken,
 NameIdentifierTree name,
 @Nullable
 SyntaxToken extendsToken,
 @Nullable
 NamespaceNameTree superClass,
 @Nullable
 SyntaxToken implementsToken,
 SeparatedListImpl<NamespaceNameTree> superInterfaces,
 SyntaxToken openCurlyBraceToken,
 List<ClassMemberTree> members,
 SyntaxToken closeCurlyBraceToken)

Method Details

modifierToken

@Nullable
public SyntaxToken modifierToken()

Description copied from interface: ClassDeclarationTree

Either abstract or final

Specified by:

modifierToken in interface ClassDeclarationTree

modifiersToken

public List<SyntaxToken> modifiersToken()

Description copied from interface: ClassDeclarationTree

Contain modifier tokens : abstract, final and/or readonly

Specified by:

modifiersToken in interface ClassDeclarationTree

attributeGroups

public List<AttributeGroupTree> attributeGroups()

Specified by:

attributeGroups in interface HasAttributes

classToken

public SyntaxToken classToken()

Description copied from interface: ClassDeclarationTree

Either class, trait, interface or enum

Specified by:

classToken in interface ClassDeclarationTree

Specified by:

classToken in interface ClassTree

name

public NameIdentifierTree name()

Specified by:

name in interface ClassDeclarationTree

extendsToken

@Nullable
public SyntaxToken extendsToken()

Specified by:

extendsToken in interface ClassDeclarationTree

Specified by:

extendsToken in interface ClassTree

superClass

@Nullable
public NamespaceNameTree superClass()

Specified by:

superClass in interface ClassDeclarationTree

Specified by:

superClass in interface ClassTree

implementsToken

@Nullable
public SyntaxToken implementsToken()

Specified by:

implementsToken in interface ClassDeclarationTree

Specified by:

implementsToken in interface ClassTree

superInterfaces

public SeparatedListImpl<NamespaceNameTree> superInterfaces()

Specified by:

superInterfaces in interface ClassDeclarationTree

Specified by:

superInterfaces in interface ClassTree

openCurlyBraceToken

public SyntaxToken openCurlyBraceToken()

Specified by:

openCurlyBraceToken in interface ClassDeclarationTree

Specified by:

openCurlyBraceToken in interface ClassTree

members

public List<ClassMemberTree> members()

Specified by:

members in interface ClassDeclarationTree

Specified by:

members in interface ClassTree

closeCurlyBraceToken

public SyntaxToken closeCurlyBraceToken()

Specified by:

closeCurlyBraceToken in interface ClassDeclarationTree

Specified by:

closeCurlyBraceToken in interface ClassTree

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface ClassDeclarationTree

isFinal

public boolean isFinal()

Specified by:

isFinal in interface ClassDeclarationTree

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface ClassDeclarationTree

fetchConstructor

@Nullable
public MethodDeclarationTree fetchConstructor()

Description copied from interface: ClassTree

Fetch class constructor declaration within class members. Will look for a method named "__construct", if cannot be found it will search for the old-style constructor function, by the name of the class.

Specified by:

fetchConstructor in interface ClassTree

Returns:

the class constructor method declaration if defined, null otherwise.

getKind

public Tree.Kind getKind()

Specified by:

getKind in interface Tree

childrenIterator

public Iterator<Tree> childrenIterator()

Description copied from class: PHPTree

Creates iterator for children of this node. Note that iterator may contain null elements.

Specified by:

childrenIterator in class PHPTree

accept

public void accept(VisitorCheck visitor)

Specified by:

accept in interface Tree

createInterface

public static ClassDeclarationTree createInterface(List<AttributeGroupTree> attributes,
 InternalSyntaxToken interfaceToken,
 NameIdentifierTree name,
 @Nullable
 InternalSyntaxToken extendsToken,
 SeparatedListImpl<NamespaceNameTree> interfaceList,
 InternalSyntaxToken openCurlyBraceToken,
 List<ClassMemberTree> members,
 InternalSyntaxToken closeCurlyBraceToken)

createTrait

public static ClassDeclarationTree createTrait(List<AttributeGroupTree> attributes,
 InternalSyntaxToken traitToken,
 NameIdentifierTree name,
 InternalSyntaxToken openCurlyBraceToken,
 List<ClassMemberTree> members,
 InternalSyntaxToken closeCurlyBraceToken)

createClass

public static ClassDeclarationTree createClass(List<AttributeGroupTree> attributes,
 List<SyntaxToken> modifiersToken,
 InternalSyntaxToken classToken,
 NameIdentifierTree name,
 @Nullable
 InternalSyntaxToken extendsToken,
 @Nullable
 NamespaceNameTree superClass,
 @Nullable
 InternalSyntaxToken implementsToken,
 SeparatedListImpl<NamespaceNameTree> superInterfaces,
 InternalSyntaxToken openCurlyBraceToken,
 List<ClassMemberTree> members,
 InternalSyntaxToken closeCurlyBraceToken)

symbol

public ClassSymbol symbol()

Specified by:

symbol in interface HasClassSymbol

setSymbol

public void setSymbol(ClassSymbol symbol)

Specified by:

setSymbol in interface HasClassSymbol