edu.umd.cs.findbugs.ba.constant

Class Constant

java.lang.Object

edu.umd.cs.findbugs.ba.constant.Constant

public class Constant
extends java.lang.Object

Abstract dataflow value representing a value which may or may not be a constant.

Author:

David Hovemeyer

See Also:

ConstantAnalysis

Field Summary

Fields

Modifier and Type	Field and Description
static Constant	NOT_CONSTANT Single instance representing all non-constant values.

Constructor Summary

Constructors

Constructor and Description
Constant(java.lang.Object value) Constructor for a constant value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getConstantInt() Get the constant int value of this value.
java.lang.String	getConstantString() Get the constant String value of this value.
java.lang.Object	getConstantValue()
int	hashCode()
boolean	isConstant() Return whether or not this value is a constant.
boolean	isConstantInteger() Return whether or not this value is a constant int/Integer.
boolean	isConstantString() Return whether or not this value is a constant String.
static Constant	merge(Constant a, Constant b) Merge two Constants.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NOT_CONSTANT

public static final Constant NOT_CONSTANT

Single instance representing all non-constant values.

Constructor Detail

Constant

public Constant(@Nullable
        java.lang.Object value)

Constructor for a constant value.

Parameters:

value - the constant value; must be a String, Integer, etc.

Method Detail

getConstantValue

public java.lang.Object getConstantValue()

isConstant

public boolean isConstant()

Return whether or not this value is a constant.

Returns:

true if the value is a constant, false if not

isConstantString

public boolean isConstantString()

Return whether or not this value is a constant String.

Returns:

true if the value is a constant String, false if not

getConstantString

public java.lang.String getConstantString()

Get the constant String value of this value.

Returns:

the constant String value

isConstantInteger

public boolean isConstantInteger()

Return whether or not this value is a constant int/Integer.

Returns:

true if the value is a constant int/Integer, false if not

getConstantInt

public int getConstantInt()

Get the constant int value of this value.

Returns:

the constant int value

merge

public static Constant merge(Constant a,
             Constant b)

Merge two Constants.

Parameters:

a - a StaticConstant

b - another StaticConstant

Returns:

the merge (dataflow meet) of the two Constants

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object