javassist

Class CtMember

java.lang.Object

javassist.CtMember

Direct Known Subclasses:

CtBehavior, CtField

public abstract class CtMember
extends java.lang.Object

An instance of CtMember represents a field, a constructor, or a method.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object[]	getAnnotations() Returns the annotations associated with this member.
abstract byte[]	getAttribute(java.lang.String name) Obtains a user-defined attribute with the given name.
abstract java.lang.Object[]	getAvailableAnnotations() Returns the annotations associated with this member.
CtClass	getDeclaringClass() Returns the class that declares this member.
abstract int	getModifiers() Obtains the modifiers of the member.
abstract java.lang.String	getName() Obtains the name of the member.
abstract java.lang.String	getSignature() Returns the character string representing the signature of the member.
abstract void	setAttribute(java.lang.String name, byte[] data) Adds a user-defined attribute.
abstract void	setModifiers(int mod) Sets the encoded modifiers of the member.
java.lang.String	toString()
boolean	visibleFrom(CtClass clazz) Returns true if this member is accessible from the given class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDeclaringClass

public CtClass getDeclaringClass()

Returns the class that declares this member.

visibleFrom

public boolean visibleFrom(CtClass clazz)

Returns true if this member is accessible from the given class.

getModifiers

public abstract int getModifiers()

Obtains the modifiers of the member.

Returns:

modifiers encoded with javassist.Modifier.

See Also:

Modifier

setModifiers

public abstract void setModifiers(int mod)

Sets the encoded modifiers of the member.

See Also:

Modifier

getAnnotations

public abstract java.lang.Object[] getAnnotations()
                                           throws java.lang.ClassNotFoundException

Returns the annotations associated with this member. For example, if an annotation @Author is associated with this member, the returned array contains an Author object. The member values can be obtained by calling methods on the Author object.

Returns:

an array of annotation-type objects.

Throws:

java.lang.ClassNotFoundException

See Also:

CtClass.getAnnotations()

getAvailableAnnotations

public abstract java.lang.Object[] getAvailableAnnotations()

Returns the annotations associated with this member. This method is equivalent to getAnnotations() except that, if any annotations are not on the classpath, they are not included in the returned array.

Returns:

an array of annotation-type objects.

Since:

3.3

See Also:

getAnnotations(), CtClass.getAvailableAnnotations()

getName

public abstract java.lang.String getName()

Obtains the name of the member.

As for constructor names, see getName() in CtConstructor.

See Also:

CtConstructor.getName()

getSignature

public abstract java.lang.String getSignature()

Returns the character string representing the signature of the member. If two members have the same signature (parameter types etc.), getSignature() returns the same string.

getAttribute

public abstract byte[] getAttribute(java.lang.String name)

Obtains a user-defined attribute with the given name. If that attribute is not found in the class file, this method returns null.

Note that an attribute is a data block specified by the class file format. See AttributeInfo.

Parameters:

name - attribute name

setAttribute

public abstract void setAttribute(java.lang.String name,
                                  byte[] data)

Adds a user-defined attribute. The attribute is saved in the class file.

Note that an attribute is a data block specified by the class file format. See AttributeInfo.

Parameters:

name - attribute name

data - attribute value