Package sootup.java.core

Class JavaSootField

java.lang.Object

sootup.core.model.SootClassMember<FieldSignature>

sootup.java.core.JavaSootField

All Implemented Interfaces:

Field, HasPosition, SootField, HasAnnotation, HasGenericSignature

public class JavaSootField
extends SootClassMember<FieldSignature>
implements SootField, HasAnnotation, HasGenericSignature

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaSootField.JavaSootFieldBuilder	Defines a SootField builder to provide a fluent API.

Field Summary

Fields inherited from class sootup.core.model.SootClassMember

position, signature

Constructor Summary

Constructors

Constructor	Description
JavaSootField(@NonNull FieldSignature signature, @NonNull Iterable<FieldModifier> modifiers, @NonNull Iterable<AnnotationUsage> annotations, @NonNull Position position)	Constructs a Soot field with the given name, type and modifiers.
JavaSootField(@NonNull FieldSignature signature, @NonNull Iterable<FieldModifier> modifiers, @NonNull Iterable<AnnotationUsage> annotations, @NonNull Position position, @Nullable String genericSignature)	Constructs a field with an optional classfile Signature attribute.
JavaSootField(@NonNull FieldSignature signature, @NonNull Iterable<FieldModifier> modifiers, @NonNull Iterable<AnnotationUsage> annotations, @NonNull Position position, @Nullable Constant constantValue)	Constructs a field with an optional classfile ConstantValue attribute.
JavaSootField(@NonNull FieldSignature signature, @NonNull Iterable<FieldModifier> modifiers, @NonNull Iterable<AnnotationUsage> annotations, @NonNull Position position, @Nullable Constant constantValue, @Nullable String genericSignature)	Constructs a field with optional classfile ConstantValue and Signature attributes.
JavaSootField(@NonNull FieldSignature signature, @NonNull Iterable<FieldModifier> modifiers, @NonNull Position position)	Constructs a Soot field with the given name, type and modifiers.

Method Summary

Modifier and Type	Method	Description
int	equivHashCode()	Returns a hash code for this method consistent with structural equality.
@NonNull Iterable<AnnotationUsage>	getAnnotations()
@NonNull Optional<Constant>	getConstantValue()	Returns the classfile ConstantValue attribute, or an empty optional if absent.
@NonNull ClassType	getDeclaringClassType()	Returns the SootClass declaring this one.
@NonNull Optional<String>	getGenericSignature()	Returns the unparsed classfile Signature attribute, or an empty optional if absent.
@NonNull Set<FieldModifier>	getModifiers()	Gets the modifiers of this class member in an immutable set.
@NonNull Type	getType()
boolean	isFinal()	Convenience method returning true if this field is final.
boolean	isPrivate()	Convenience method returning true if this class member is private.
boolean	isProtected()	Convenience method returning true if this class member is protected.
boolean	isPublic()	Convenience method returning true if this class member is public.
boolean	isStatic()	Convenience method returning true if this class member is static.
@NonNull JavaSootField	withAnnotations(@NonNull Iterable<AnnotationUsage> annotations)
@NonNull JavaSootField	withConstantValue(@Nullable Constant constantValue)
@NonNull JavaSootField	withGenericSignature(@Nullable String genericSignature)
@NonNull JavaSootField	withModifiers(@NonNull Iterable<FieldModifier> modifiers)
@NonNull JavaSootField	withSignature(@NonNull FieldSignature signature)

Methods inherited from class sootup.core.model.SootClassMember

getName, getPosition, getSignature, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface sootup.core.model.Field

getSignature

Methods inherited from interface sootup.core.model.SootField

getName

Constructor Details

JavaSootField

public JavaSootField(@NonNull FieldSignature signature,
 @NonNull Iterable<FieldModifier> modifiers,
 @NonNull Position position)

Constructs a Soot field with the given name, type and modifiers.

JavaSootField

public JavaSootField(@NonNull FieldSignature signature,
 @NonNull Iterable<FieldModifier> modifiers,
 @NonNull Iterable<AnnotationUsage> annotations,
 @NonNull Position position)

Constructs a Soot field with the given name, type and modifiers.

Parameters:

signature - the signature of the field

modifiers - modifier of the field

annotations - annotations of the field

position - position of the field

JavaSootField

public JavaSootField(@NonNull FieldSignature signature,
 @NonNull Iterable<FieldModifier> modifiers,
 @NonNull Iterable<AnnotationUsage> annotations,
 @NonNull Position position,
 @Nullable Constant constantValue)

Constructs a field with an optional classfile ConstantValue attribute.

Parameters:

signature - the erased field signature

modifiers - the field modifiers

annotations - the field annotations

position - the source position

constantValue - the ConstantValue attribute, or null if absent

JavaSootField

public JavaSootField(@NonNull FieldSignature signature,
 @NonNull Iterable<FieldModifier> modifiers,
 @NonNull Iterable<AnnotationUsage> annotations,
 @NonNull Position position,
 @Nullable String genericSignature)

Constructs a field with an optional classfile Signature attribute.

Parameters:

signature - the erased field signature

modifiers - the field modifiers

annotations - the field annotations

position - the source position

genericSignature - the unparsed Signature attribute, or null if absent

JavaSootField

public JavaSootField(@NonNull FieldSignature signature,
 @NonNull Iterable<FieldModifier> modifiers,
 @NonNull Iterable<AnnotationUsage> annotations,
 @NonNull Position position,
 @Nullable Constant constantValue,
 @Nullable String genericSignature)

Constructs a field with optional classfile ConstantValue and Signature attributes.

Parameters:

signature - the erased field signature

modifiers - the field modifiers

annotations - the field annotations

position - the source position

constantValue - the ConstantValue attribute, or null if absent

genericSignature - the unparsed Signature attribute, or null if absent

Method Details

getConstantValue

public @NonNull Optional<Constant> getConstantValue()

Returns the classfile ConstantValue attribute, or an empty optional if absent. This does not infer values from field initializers. Boolean, byte, char and short attributes are represented as integer constants, matching their classfile representation.

getGenericSignature

public @NonNull Optional<String> getGenericSignature()

Returns the unparsed classfile Signature attribute, or an empty optional if absent.

Specified by:

getGenericSignature in interface HasGenericSignature

Returns:

the raw classfile generic signature, or empty if absent

isProtected

public boolean isProtected()

Description copied from class: SootClassMember

Convenience method returning true if this class member is protected.

Specified by:

isProtected in interface SootField

Specified by:

isProtected in class SootClassMember<FieldSignature>

isPrivate

public boolean isPrivate()

Description copied from class: SootClassMember

Convenience method returning true if this class member is private.

Specified by:

isPrivate in interface SootField

Specified by:

isPrivate in class SootClassMember<FieldSignature>

isPublic

public boolean isPublic()

Description copied from class: SootClassMember

Convenience method returning true if this class member is public.

Specified by:

isPublic in interface SootField

Specified by:

isPublic in class SootClassMember<FieldSignature>

isStatic

public boolean isStatic()

Description copied from class: SootClassMember

Convenience method returning true if this class member is static.

Specified by:

isStatic in interface SootField

Specified by:

isStatic in class SootClassMember<FieldSignature>

isFinal

public boolean isFinal()

Description copied from class: SootClassMember

Convenience method returning true if this field is final.

Specified by:

isFinal in interface SootField

Specified by:

isFinal in class SootClassMember<FieldSignature>

getModifiers

public @NonNull Set<FieldModifier> getModifiers()

Gets the modifiers of this class member in an immutable set.

Specified by:

getModifiers in interface SootField

See Also:

• FieldModifier

equivHashCode

public int equivHashCode()

Description copied from class: SootClassMember

Returns a hash code for this method consistent with structural equality.

Specified by:

equivHashCode in class SootClassMember<FieldSignature>

getType

public @NonNull Type getType()

Specified by:

getType in interface SootField

withSignature

public @NonNull JavaSootField withSignature(@NonNull FieldSignature signature)

Specified by:

withSignature in interface SootField

withModifiers

public @NonNull JavaSootField withModifiers(@NonNull Iterable<FieldModifier> modifiers)

Specified by:

withModifiers in interface SootField

getDeclaringClassType

public @NonNull ClassType getDeclaringClassType()

Returns the SootClass declaring this one.

Specified by:

getDeclaringClassType in interface SootField

Overrides:

getDeclaringClassType in class SootClassMember<FieldSignature>

getAnnotations

public @NonNull Iterable<AnnotationUsage> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotation

withAnnotations

public @NonNull JavaSootField withAnnotations(@NonNull Iterable<AnnotationUsage> annotations)

withConstantValue

public @NonNull JavaSootField withConstantValue(@Nullable Constant constantValue)

withGenericSignature

public @NonNull JavaSootField withGenericSignature(@Nullable String genericSignature)