Package sootup.core.model

Class SootField

java.lang.Object

sootup.core.model.SootClassMember<FieldSignature>

sootup.core.model.SootField

All Implemented Interfaces:

Field, HasPosition

Direct Known Subclasses:

JavaSootField

public class SootField
extends SootClassMember<FieldSignature>
implements Field

Soot's counterpart of the source language's field concept. Soot representation of a Java field. Can be declared to belong to a SootClass.

Author:

Linghui Luo, Jan Martin Persch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SootField.BuildStep
static interface	SootField.ModifierStep
static interface	SootField.SignatureStep
static class	SootField.SootFieldBuilder	Defines a SootField builder to provide a fluent API.

Constructor Summary

Constructors

Constructor	Description
SootField(FieldSignature signature, Iterable<FieldModifier> modifiers, Position position)	Constructs a Soot field with the given name, type and modifiers.

Method Summary

Modifier and Type	Method	Description
static SootField.SignatureStep	builder()	Creates a SootField
int	equivHashCode()	Returns a hash code for this method consistent with structural equality.
Set<FieldModifier>	getModifiers()	Gets the modifiers of this class member in an immutable set.
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.
SootField	withModifiers(Iterable<FieldModifier> modifiers)
SootField	withSignature(FieldSignature signature)

Methods inherited from class sootup.core.model.SootClassMember

getDeclaringClassType, 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

Constructor Details

SootField

public SootField(@Nonnull
 FieldSignature signature,
 @Nonnull
 Iterable<FieldModifier> modifiers,
 @Nonnull
 Position position)

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

Method Details

isProtected

public boolean isProtected()

Description copied from class: SootClassMember

Convenience method returning true if this class member is protected.

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 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 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 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 class SootClassMember<FieldSignature>

getModifiers

@Nonnull
public Set<FieldModifier> getModifiers()

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

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

@Nonnull
public Type getType()

withSignature

@Nonnull
public SootField withSignature(@Nonnull
 FieldSignature signature)

withModifiers

@Nonnull
public SootField withModifiers(@Nonnull
 Iterable<FieldModifier> modifiers)

builder

@Nonnull
public static SootField.SignatureStep builder()

Creates a SootField

Returns:

A SootField