Interface FieldDescription

All Superinterfaces:

AnnotationSource, ByteCodeElement, ByteCodeElement.Member, ByteCodeElement.TypeDependant<FieldDescription.InDefinedShape, FieldDescription.Token>, DeclaredByType, DeclaredByType.WithMandatoryDeclaration, ModifierReviewable, ModifierReviewable.ForFieldDescription, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, NamedElement, NamedElement.WithDescriptor, NamedElement.WithGenericName, NamedElement.WithRuntimeName

All Known Subinterfaces:

FieldDescription.InDefinedShape, FieldDescription.InGenericShape

All Known Implementing Classes:

FieldDescription.AbstractBase, FieldDescription.ForLoadedField, FieldDescription.InDefinedShape.AbstractBase, FieldDescription.Latent, FieldDescription.TypeSubstituting, Implementation.Context.Default.CacheValueField, Transformer.ForField.TransformedField, TypePool.Default.LazyTypeDescription.LazyFieldDescription

public interface FieldDescription
extends ModifierReviewable.ForFieldDescription, DeclaredByType.WithMandatoryDeclaration, ByteCodeElement.Member, ByteCodeElement.TypeDependant<FieldDescription.InDefinedShape, FieldDescription.Token>

Implementations of this interface describe a Java field. Implementations of this interface must provide meaningful equal(Object) and hashCode() implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FieldDescription.AbstractBase	An abstract base implementation of a field description.
static class	FieldDescription.ForLoadedField	An implementation of a field description for a loaded field.
static interface	FieldDescription.InDefinedShape	Represents a field in its defined shape, i.e.
static interface	FieldDescription.InGenericShape	Represents a field description in its generic shape, i.e.
static class	FieldDescription.Latent	A latent field description describes a field that is not attached to a declaring TypeDescription.
static class	FieldDescription.SignatureToken	A token that uniquely identifies a field by its name and type erasure.
static class	FieldDescription.Token	A token representing a field's properties detached from a type.
static class	FieldDescription.TypeSubstituting	A field description that represents a given field but with a substituted field type.

Nested classes/interfaces inherited from interface AnnotationSource

AnnotationSource.Empty, AnnotationSource.Explicit

Nested classes/interfaces inherited from interface ByteCodeElement

ByteCodeElement.Member, ByteCodeElement.TypeDependant<T,S>

Nested classes/interfaces inherited from interface DeclaredByType

DeclaredByType.WithMandatoryDeclaration

Nested classes/interfaces inherited from interface ModifierReviewable

ModifierReviewable.ForFieldDescription, ModifierReviewable.ForMethodDescription, ModifierReviewable.ForModuleDescription, ModifierReviewable.ForModuleRequirement, ModifierReviewable.ForParameterDescription, ModifierReviewable.ForTypeDefinition, ModifierReviewable.OfAbstraction, ModifierReviewable.OfByteCodeElement, ModifierReviewable.OfEnumeration, ModifierReviewable.OfMandatable

Nested classes/interfaces inherited from interface NamedElement

NamedElement.WithDescriptor, NamedElement.WithGenericName, NamedElement.WithOptionalName, NamedElement.WithRuntimeName

Field Summary

Fields

Modifier and Type	Field	Description
static final Object	NO_DEFAULT_VALUE	A representative of a field's non-set default value.

Fields inherited from interface ModifierReviewable

EMPTY_MASK

Fields inherited from interface NamedElement

EMPTY_NAME, NO_NAME

Fields inherited from interface NamedElement.WithDescriptor

NON_GENERIC_SIGNATURE

Method Summary

Modifier and Type	Method	Description
FieldDescription.SignatureToken	asSignatureToken()	Returns a signature token representing this field.
int	getActualModifiers()	Returns the field's actual modifiers as it is present in a class file, i.e.
TypeDefinition	getDeclaringType()	Returns the declaring type of this instance.
TypeDescription.Generic	getType()	Returns the type of the described field.

Methods inherited from interface AnnotationSource

getDeclaredAnnotations

Methods inherited from interface ByteCodeElement

isAccessibleTo, isVisibleTo

Methods inherited from interface ByteCodeElement.TypeDependant

asDefined, asToken

Methods inherited from interface ModifierReviewable

getModifiers, getSyntheticState, isFinal, isSynthetic

Methods inherited from interface ModifierReviewable.ForFieldDescription

getFieldManifestation, getFieldPersistence, isTransient, isVolatile

Methods inherited from interface ModifierReviewable.OfByteCodeElement

getOwnership, getVisibility, isDeprecated, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface ModifierReviewable.OfEnumeration

getEnumerationState, isEnum

Methods inherited from interface NamedElement

getActualName

Methods inherited from interface NamedElement.WithDescriptor

getDescriptor, getGenericSignature

Methods inherited from interface NamedElement.WithGenericName

toGenericString

Methods inherited from interface NamedElement.WithRuntimeName

getInternalName, getName

Field Details

NO_DEFAULT_VALUE

@AlwaysNull
static final Object NO_DEFAULT_VALUE

A representative of a field's non-set default value.

Method Details

getDeclaringType

@Nonnull
TypeDefinition getDeclaringType()

Returns the declaring type of this instance.

Specified by:

getDeclaringType in interface DeclaredByType

Specified by:

getDeclaringType in interface DeclaredByType.WithMandatoryDeclaration

Returns:

The declaring type or null if no such type exists.

getType

TypeDescription.Generic getType()

Returns the type of the described field.

Returns:

The type of the described field.

getActualModifiers

int getActualModifiers()

Returns the field's actual modifiers as it is present in a class file, i.e. its modifiers including a flag if this field is deprecated.

Returns:

The field's actual modifiers.

asSignatureToken

FieldDescription.SignatureToken asSignatureToken()

Returns a signature token representing this field.

Returns:

A signature token representing this field.