SootField (Soot - a J*va Optimization Framework 4.2.1 API)

java.lang.Object
- soot.tagkit.AbstractHost
- - soot.SootField

All Implemented Interfaces:

ClassMember, PaddleField, SparkField, Host, Numberable
```
public class SootField
extends AbstractHost
implements ClassMember, SparkField, Numberable, PaddleField
```
Soot representation of a Java field. Can be declared to belong to a SootClass.

Field Summary

Fields
Modifier and Type	Field and Description
`protected SootClass`	`declaringClass`
`protected boolean`	`isDeclared`
`protected boolean`	`isPhantom`
`protected int`	`modifiers`
`protected String`	`name`
`protected String`	`sig`
`protected String`	`subSig`
`protected Type`	`type`

Fields inherited from class soot.tagkit.AbstractHost
col, line, mTagList

Constructor Summary

Constructors
Constructor and Description
`SootField(String name, Type type)` Constructs a Soot field with the given name, type and no modifiers.
`SootField(String name, Type type, int modifiers)` Constructs a Soot field with the given name, type and modifiers.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`equivHashCode()`
`String`	`getDeclaration()`
`SootClass`	`getDeclaringClass()` Returns the SootClass declaring this one.
`int`	`getModifiers()` Returns modifiers of this class member.
`String`	`getName()`
`int`	`getNumber()`
`String`	`getSignature()`
`static String`	`getSignature(SootClass cl, String subSignature)`
`static String`	`getSignature(SootClass cl, String name, Type type)`
`String`	`getSubSignature()`
`protected static String`	`getSubSignature(String name, Type type)`
`Type`	`getType()`
`boolean`	`isDeclared()` Returns true when some SootClass object declares this object.
`boolean`	`isFinal()` Convenience method returning true if this field is final.
`boolean`	`isPhantom()` Returns true when this object is from a phantom class.
`boolean`	`isPrivate()` Convenience method returning true if this field is private.
`boolean`	`isProtected()` Convenience method returning true if this field is protected.
`boolean`	`isPublic()` Convenience method returning true if this field is public.
`boolean`	`isStatic()` Convenience method returning true if this field is static.
`SootFieldRef`	`makeRef()`
`void`	`setDeclared(boolean isDeclared)`
`void`	`setDeclaringClass(SootClass sc)`
`void`	`setModifiers(int modifiers)` Sets modifiers of this class member.
`void`	`setName(String name)`
`void`	`setNumber(int number)`
`void`	`setPhantom(boolean value)` Sets the phantom flag
`void`	`setType(Type t)`
`String`	`toString()`

Methods inherited from class soot.tagkit.AbstractHost
addAllTagsOf, addTag, getJavaSourceStartColumnNumber, getJavaSourceStartLineNumber, getTag, getTags, hasTag, removeAllTags, removeTag

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - type
```
protected Type type
```
  - modifiers
```
protected int modifiers
```
  - isDeclared
```
protected boolean isDeclared
```
  - declaringClass
```
protected SootClass declaringClass
```
  - isPhantom
```
protected boolean isPhantom
```
  - sig
```
protected volatile String sig
```
  - subSig
```
protected volatile String subSig
```
- Constructor Detail
  - SootField
```
public SootField(String name,
                 Type type,
                 int modifiers)
```
    Constructs a Soot field with the given name, type and modifiers.
  - SootField
```
public SootField(String name,
                 Type type)
```
    Constructs a Soot field with the given name, type and no modifiers.
- Method Detail
  - equivHashCode
```
public int equivHashCode()
```
  - getSignature
```
public String getSignature()
```
  - getSignature
```
public static String getSignature(SootClass cl,
                                  String name,
                                  Type type)
```
  - getSignature
```
public static String getSignature(SootClass cl,
                                  String subSignature)
```
  - getSubSignature
```
public String getSubSignature()
```
  - getSubSignature
```
protected static String getSubSignature(String name,
                                        Type type)
```
  - getDeclaringClass
```
public SootClass getDeclaringClass()
```
    Description copied from interface: ClassMember
    
    Returns the SootClass declaring this one.
    
    Specified by:
    
    getDeclaringClass in interface ClassMember
  - setDeclaringClass
```
public void setDeclaringClass(SootClass sc)
```
  - isPhantom
```
public boolean isPhantom()
```
    Description copied from interface: ClassMember
    
    Returns true when this object is from a phantom class.
    
    Specified by:
    
    isPhantom in interface ClassMember
  - setPhantom
```
public void setPhantom(boolean value)
```
    Description copied from interface: ClassMember
    
    Sets the phantom flag
    
    Specified by:
    
    setPhantom in interface ClassMember
  - isDeclared
```
public boolean isDeclared()
```
    Description copied from interface: ClassMember
    
    Returns true when some SootClass object declares this object.
    
    Specified by:
    
    isDeclared in interface ClassMember
  - setDeclared
```
public void setDeclared(boolean isDeclared)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getType
```
public Type getType()
```
    Specified by:
    
    getType in interface SparkField
  - setType
```
public void setType(Type t)
```
  - isPublic
```
public boolean isPublic()
```
    Convenience method returning true if this field is public.
    
    Specified by:
    
    isPublic in interface ClassMember
  - isProtected
```
public boolean isProtected()
```
    Convenience method returning true if this field is protected.
    
    Specified by:
    
    isProtected in interface ClassMember
  - isPrivate
```
public boolean isPrivate()
```
    Convenience method returning true if this field is private.
    
    Specified by:
    
    isPrivate in interface ClassMember
  - isStatic
```
public boolean isStatic()
```
    Convenience method returning true if this field is static.
    
    Specified by:
    
    isStatic in interface ClassMember
  - isFinal
```
public boolean isFinal()
```
    Convenience method returning true if this field is final.
  - setModifiers
```
public void setModifiers(int modifiers)
```
    Description copied from interface: ClassMember
    
    Sets modifiers of this class member.
    
    Specified by:
    
    setModifiers in interface ClassMember
  - getModifiers
```
public int getModifiers()
```
    Description copied from interface: ClassMember
    
    Returns modifiers of this class member.
    
    Specified by:
    
    getModifiers in interface ClassMember
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDeclaration
```
public String getDeclaration()
```
  - getNumber
```
public final int getNumber()
```
    Specified by:
    
    getNumber in interface Numberable
  - setNumber
```
public final void setNumber(int number)
```
    Specified by:
    
    setNumber in interface Numberable
  - makeRef
```
public SootFieldRef makeRef()
```

Class SootField

Field Summary

Fields inherited from class soot.tagkit.AbstractHost

Constructor Summary

Method Summary

Methods inherited from class soot.tagkit.AbstractHost

Methods inherited from class java.lang.Object

Field Detail

name

type

modifiers

isDeclared

declaringClass

isPhantom

sig

subSig

Constructor Detail

SootField

SootField

Method Detail

equivHashCode

getSignature

getSignature

getSignature

getSubSignature

getSubSignature

getDeclaringClass

setDeclaringClass

isPhantom

setPhantom

isDeclared

setDeclared

getName

setName

getType

setType

isPublic

isProtected

isPrivate

isStatic

isFinal

setModifiers

getModifiers

toString

getDeclaration

getNumber

setNumber

makeRef