OpcodeStack.Item (findbugs 3.0.1)

java.lang.Object
- edu.umd.cs.findbugs.OpcodeStack.Item

Enclosing class:: OpcodeStack

public static class OpcodeStack.Item
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface OpcodeStack.Item.SpecialKind

Nested Classes
Modifier and Type	Class and Description
`static interface`	`OpcodeStack.Item.SpecialKind`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AVERAGE_COMPUTED_USING_DIVISION`
`static int`	`FILE_OPENED_IN_APPEND_MODE`
`static int`	`FILE_SEPARATOR_STRING`
`static int`	`FLOAT_MATH`
`static int`	`HASHCODE_INT`
`static int`	`HASHCODE_INT_REMAINDER`
`static int`	`INTEGER_SUM`
`static int`	`LOW_8_BITS_CLEAR`
`static int`	`MATH_ABS`
`static int`	`MATH_ABS_OF_HASHCODE`
`static int`	`MATH_ABS_OF_RANDOM`
`static int`	`NASTY_FLOAT_MATH`
`static int`	`NEWLY_ALLOCATED`
`static int`	`NON_NEGATIVE`
`static int`	`NONZERO_MEANS_NULL`
`static int`	`NOT_SPECIAL`
`static int`	`RANDOM_INT`
`static int`	`RANDOM_INT_REMAINDER`
`static int`	`RESULT_OF_I2L`
`static int`	`RESULT_OF_L2I`
`static int`	`SERVLET_OUTPUT`
`static int`	`SERVLET_REQUEST_TAINTED`
`static int`	`SIGNED_BYTE`
`static HashMap<Integer,String>`	`specialKindNames`
`static int`	`TYPE_ONLY`
`static Object`	`UNKNOWN`
`static int`	`ZERO_MEANS_NULL`

Constructor Summary

Constructors
Constructor and Description
`OpcodeStack.Item()`
`OpcodeStack.Item(OpcodeStack.Item it)`
`OpcodeStack.Item(OpcodeStack.Item it, int reg)`
`OpcodeStack.Item(OpcodeStack.Item it, String signature)`
`OpcodeStack.Item(String signature)`
`OpcodeStack.Item(String signature, FieldAnnotation f)`
`OpcodeStack.Item(String signature, FieldAnnotation f, int fieldLoadedFromRegister)`
`OpcodeStack.Item(String signature, int constValue)`
`OpcodeStack.Item(String signature, Object constantValue)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`checkForIntegerMinValue()` Value could be Integer.MIN_VALUE
`void`	`clearNewlyAllocated()`
`OpcodeStack.Item`	`cloneAndSetSpecialKind(int specialKind)`
`boolean`	`couldBeZero()`
`static int`	`defineNewSpecialKind(String name)`
`boolean`	`equals(Object o)`
`Object`	`getConstant()` Returns a constant value for this Item, if known.
`String`	`getElementSignature()` Deprecated.
`FieldAnnotation`	`getFieldAnnotation()` Deprecated.
`int`	`getFieldLoadedFromRegister()` If this value was loaded from an instance field, give the register number containing the object that the field was loaded from.
`String`	`getHttpParameterName()`
`int`	`getInjectionPC()`
`org.apache.bcel.classfile.JavaClass`	`getJavaClass()` Returns null for primitive and arrays
`int`	`getPC()`
`int`	`getRegisterNumber()`
`XMethod`	`getReturnValueOf()`
`String`	`getSignature()`
`int`	`getSize()`
`int`	`getSpecialKind()`
`int`	`getSpecialKindForAbs()`
`int`	`getSpecialKindForRemainder()`
`Object`	`getUserValue()` gets the detector specified value for this item
`XField`	`getXField()`
`boolean`	`hasConstantValue(int value)`
`boolean`	`hasConstantValue(long value)`
`int`	`hashCode()`
`static OpcodeStack.Item`	`initialArgument(String signature, int reg)`
`boolean`	`isArray()`
`boolean`	`isBooleanNullnessValue()`
`boolean`	`isInitialParameter()`
`boolean`	`isNewlyAllocated()`
`boolean`	`isNonNegative()`
`boolean`	`isNull()`
`boolean`	`isPrimitive()`
`boolean`	`isServletParameterTainted()`
`boolean`	`isServletWriter()`
`boolean`	`isWide()`
`void`	`makeCrossMethod()`
`static OpcodeStack.Item`	`merge(OpcodeStack.Item i1, OpcodeStack.Item i2)`
`boolean`	`mightRarelyBeNegative()` The result of applying Math.abs to a checkForIntegerMinValue() value
`boolean`	`mustBeZero()`
`static OpcodeStack.Item`	`nullItem(String signature)`
`boolean`	`sameValue(OpcodeStack.Item that)`
`void`	`setCouldBeNegative()`
`void`	`setIsServletWriter()`
`void`	`setLoadedFromField(XField f, int fieldLoadedFromRegister)`
`void`	`setPC(int pc)`
`void`	`setServletParameterTainted()`
`void`	`setSpecialKind(int specialKind)`
`void`	`setUserValue(Object value)` attaches a detector specified value to this item to use this method, detector should be annotated with `CustomUserValue`.
`String`	`toString()`
`static OpcodeStack.Item`	`typeOnly(String signature)`
`boolean`	`usesTwoSlots()`
`boolean`	`valueCouldBeNegative()`

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

Field Detail

NOT_SPECIAL

@OpcodeStack.Item.SpecialKind
public static final int NOT_SPECIAL

See Also:: Constant Field Values

SIGNED_BYTE

@OpcodeStack.Item.SpecialKind
public static final int SIGNED_BYTE

See Also:: Constant Field Values

RANDOM_INT

@OpcodeStack.Item.SpecialKind
public static final int RANDOM_INT

See Also:: Constant Field Values

LOW_8_BITS_CLEAR

@OpcodeStack.Item.SpecialKind
public static final int LOW_8_BITS_CLEAR

See Also:: Constant Field Values

HASHCODE_INT

@OpcodeStack.Item.SpecialKind
public static final int HASHCODE_INT

See Also:: Constant Field Values

INTEGER_SUM

@OpcodeStack.Item.SpecialKind
public static final int INTEGER_SUM

See Also:: Constant Field Values

AVERAGE_COMPUTED_USING_DIVISION

@OpcodeStack.Item.SpecialKind
public static final int AVERAGE_COMPUTED_USING_DIVISION

See Also:: Constant Field Values

FLOAT_MATH

@OpcodeStack.Item.SpecialKind
public static final int FLOAT_MATH

See Also:: Constant Field Values

RANDOM_INT_REMAINDER

@OpcodeStack.Item.SpecialKind
public static final int RANDOM_INT_REMAINDER

See Also:: Constant Field Values

HASHCODE_INT_REMAINDER

@OpcodeStack.Item.SpecialKind
public static final int HASHCODE_INT_REMAINDER

See Also:: Constant Field Values

FILE_SEPARATOR_STRING

@OpcodeStack.Item.SpecialKind
public static final int FILE_SEPARATOR_STRING

See Also:: Constant Field Values

MATH_ABS

@OpcodeStack.Item.SpecialKind
public static final int MATH_ABS

See Also:: Constant Field Values

MATH_ABS_OF_RANDOM

@OpcodeStack.Item.SpecialKind
public static final int MATH_ABS_OF_RANDOM

See Also:: Constant Field Values

MATH_ABS_OF_HASHCODE

@OpcodeStack.Item.SpecialKind
public static final int MATH_ABS_OF_HASHCODE

See Also:: Constant Field Values

NON_NEGATIVE

@OpcodeStack.Item.SpecialKind
public static final int NON_NEGATIVE

See Also:: Constant Field Values

NASTY_FLOAT_MATH

@OpcodeStack.Item.SpecialKind
public static final int NASTY_FLOAT_MATH

See Also:: Constant Field Values

FILE_OPENED_IN_APPEND_MODE

@OpcodeStack.Item.SpecialKind
public static final int FILE_OPENED_IN_APPEND_MODE

See Also:: Constant Field Values

SERVLET_REQUEST_TAINTED

@OpcodeStack.Item.SpecialKind
public static final int SERVLET_REQUEST_TAINTED

See Also:: Constant Field Values

NEWLY_ALLOCATED

@OpcodeStack.Item.SpecialKind
public static final int NEWLY_ALLOCATED

See Also:: Constant Field Values

ZERO_MEANS_NULL

@OpcodeStack.Item.SpecialKind
public static final int ZERO_MEANS_NULL

See Also:: Constant Field Values

NONZERO_MEANS_NULL

@OpcodeStack.Item.SpecialKind
public static final int NONZERO_MEANS_NULL

See Also:: Constant Field Values

RESULT_OF_I2L

@OpcodeStack.Item.SpecialKind
public static final int RESULT_OF_I2L

See Also:: Constant Field Values

RESULT_OF_L2I

@OpcodeStack.Item.SpecialKind
public static final int RESULT_OF_L2I

See Also:: Constant Field Values

SERVLET_OUTPUT

@OpcodeStack.Item.SpecialKind
public static final int SERVLET_OUTPUT

See Also:: Constant Field Values

TYPE_ONLY

@OpcodeStack.Item.SpecialKind
public static final int TYPE_ONLY

See Also:: Constant Field Values

specialKindNames

@StaticConstant
public static final HashMap<Integer,String> specialKindNames

UNKNOWN
```
public static final Object UNKNOWN
```

Constructor Detail

OpcodeStack.Item

public OpcodeStack.Item(String signature,
                int constValue)

OpcodeStack.Item

public OpcodeStack.Item(String signature)

OpcodeStack.Item

public OpcodeStack.Item(OpcodeStack.Item it)

OpcodeStack.Item

public OpcodeStack.Item(OpcodeStack.Item it,
                String signature)

OpcodeStack.Item

public OpcodeStack.Item(OpcodeStack.Item it,
                int reg)

OpcodeStack.Item

public OpcodeStack.Item(String signature,
                FieldAnnotation f)

OpcodeStack.Item

public OpcodeStack.Item(String signature,
                FieldAnnotation f,
                int fieldLoadedFromRegister)

OpcodeStack.Item

public OpcodeStack.Item(String signature,
                Object constantValue)

OpcodeStack.Item
```
public OpcodeStack.Item()
```

Method Detail

defineNewSpecialKind

@OpcodeStack.Item.SpecialKind
public static int defineNewSpecialKind(String name)

makeCrossMethod
```
public void makeCrossMethod()
```

getSize
```
public int getSize()
```

getPC
```
public int getPC()
```

setPC
```
public void setPC(int pc)
```

isWide
```
public boolean isWide()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

usesTwoSlots
```
public boolean usesTwoSlots()
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

sameValue

public boolean sameValue(OpcodeStack.Item that)

toString
```
public String toString()
```
Overrides:

toString in class Object

merge

public static OpcodeStack.Item merge(OpcodeStack.Item i1,
                     OpcodeStack.Item i2)

initialArgument

public static OpcodeStack.Item initialArgument(String signature,
                               int reg)

typeOnly

public static OpcodeStack.Item typeOnly(String signature)

getFieldLoadedFromRegister
```
public int getFieldLoadedFromRegister()
```
If this value was loaded from an instance field, give the register number containing the object that the field was loaded from. If Integer.MAX value, the value was loaded from a static field If -1, we don't know or don't have the register containing the object that the field was loaded from.

setLoadedFromField

public void setLoadedFromField(XField f,
                      int fieldLoadedFromRegister)

getHttpParameterName

@CheckForNull
public String getHttpParameterName()

getInjectionPC
```
public int getInjectionPC()
```

setCouldBeNegative
```
public void setCouldBeNegative()
```

nullItem

public static OpcodeStack.Item nullItem(String signature)

getJavaClass

@CheckForNull
public org.apache.bcel.classfile.JavaClass getJavaClass()
                                                 throws ClassNotFoundException

Returns null for primitive and arrays

Throws:: ClassNotFoundException

isArray
```
public boolean isArray()
```

getElementSignature

@Deprecated
public String getElementSignature()

Deprecated.

isNonNegative
```
public boolean isNonNegative()
```

isPrimitive
```
public boolean isPrimitive()
```

getRegisterNumber
```
public int getRegisterNumber()
```

getSignature
```
public String getSignature()
```

getConstant
```
public Object getConstant()
```
Returns a constant value for this Item, if known. NOTE: if the value is a constant Class object, the constant value returned is the name of the class. if the value is an array of known length, the constant value returned is its length (Integer)

getFieldAnnotation

@Deprecated
public FieldAnnotation getFieldAnnotation()

Deprecated.

Use getXField instead

getXField
```
public XField getXField()
```

setSpecialKind

public void setSpecialKind(@OpcodeStack.Item.SpecialKind
                  int specialKind)

Parameters:: specialKind - The specialKind to set.

cloneAndSetSpecialKind

public OpcodeStack.Item cloneAndSetSpecialKind(@OpcodeStack.Item.SpecialKind
                                      int specialKind)

getSpecialKind

@OpcodeStack.Item.SpecialKind
public int getSpecialKind()

Returns:: Returns the specialKind.

isBooleanNullnessValue
```
public boolean isBooleanNullnessValue()
```
Returns:
Returns the specialKind.

setUserValue
```
public void setUserValue(@Nullable
                Object value)
```
attaches a detector specified value to this item

to use this method, detector should be annotated with CustomUserValue.

Parameters:
value - the custom value to set
See Also:
OpcodeStack.CustomUserValue

getReturnValueOf
```
@CheckForNull
public XMethod getReturnValueOf()
```
Returns:
if this value is the return value of a method, give the method invoked

couldBeZero
```
public boolean couldBeZero()
```

mustBeZero
```
public boolean mustBeZero()
```

getUserValue
```
@Nullable
public Object getUserValue()
```
gets the detector specified value for this item

Returns:
the custom value

isServletParameterTainted

public boolean isServletParameterTainted()

setServletParameterTainted

public void setServletParameterTainted()

setIsServletWriter
```
public void setIsServletWriter()
```

isServletWriter
```
public boolean isServletWriter()
```

valueCouldBeNegative
```
public boolean valueCouldBeNegative()
```

getSpecialKindForAbs

@OpcodeStack.Item.SpecialKind
public int getSpecialKindForAbs()

getSpecialKindForRemainder

@OpcodeStack.Item.SpecialKind
public int getSpecialKindForRemainder()

checkForIntegerMinValue
```
public boolean checkForIntegerMinValue()
```
Value could be Integer.MIN_VALUE

mightRarelyBeNegative
```
public boolean mightRarelyBeNegative()
```
The result of applying Math.abs to a checkForIntegerMinValue() value

isInitialParameter
```
public boolean isInitialParameter()
```
Returns:
Returns the isInitialParameter.

isNull
```
public boolean isNull()
```
Returns:
Returns the isNull.

clearNewlyAllocated
```
public void clearNewlyAllocated()
```

isNewlyAllocated
```
public boolean isNewlyAllocated()
```

hasConstantValue

public boolean hasConstantValue(int value)

hasConstantValue

public boolean hasConstantValue(long value)

Class OpcodeStack.Item

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOT_SPECIAL

SIGNED_BYTE

RANDOM_INT

LOW_8_BITS_CLEAR

HASHCODE_INT

INTEGER_SUM

AVERAGE_COMPUTED_USING_DIVISION

FLOAT_MATH

RANDOM_INT_REMAINDER

HASHCODE_INT_REMAINDER

FILE_SEPARATOR_STRING

MATH_ABS

MATH_ABS_OF_RANDOM

MATH_ABS_OF_HASHCODE

NON_NEGATIVE

NASTY_FLOAT_MATH

FILE_OPENED_IN_APPEND_MODE

SERVLET_REQUEST_TAINTED

NEWLY_ALLOCATED

ZERO_MEANS_NULL

NONZERO_MEANS_NULL

RESULT_OF_I2L

RESULT_OF_L2I

SERVLET_OUTPUT

TYPE_ONLY

specialKindNames

UNKNOWN

Constructor Detail

OpcodeStack.Item

OpcodeStack.Item

OpcodeStack.Item

OpcodeStack.Item

OpcodeStack.Item

OpcodeStack.Item

OpcodeStack.Item

OpcodeStack.Item

OpcodeStack.Item

Method Detail

defineNewSpecialKind

makeCrossMethod

getSize

getPC

setPC

isWide

hashCode

usesTwoSlots

equals

sameValue

toString

merge

initialArgument

typeOnly

getFieldLoadedFromRegister

setLoadedFromField

getHttpParameterName

getInjectionPC

setCouldBeNegative

nullItem

getJavaClass

isArray

getElementSignature

isNonNegative

isPrimitive

getRegisterNumber

getSignature

getConstant

getFieldAnnotation

getXField

setSpecialKind

cloneAndSetSpecialKind

getSpecialKind

isBooleanNullnessValue

setUserValue