Constant (JEB API)

java.lang.Object
- jeb.api.ast.NonStatement
- - jeb.api.ast.Constant

All Implemented Interfaces:

IElement, IExpression
```
public class Constant
extends NonStatement
implements IExpression
```
This AST element represents a literal, or constant value.
Constant types are one of the eight primitive types (boolean, byte, char, short, int, long, float, double) or a literal string.
Constants can be created via the use of a Constant.Builder.
Note: Constants are read-only elements.

Since:

1.4.201309040

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Constant.Builder
This class is used to generate AST Constant elements.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Constant.Builder` This class is used to generate AST `Constant` elements.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBoolean()` Retrieve the boolean value.
`byte`	`getByte()` Retrieve the byte value.
`char`	`getChar()` Retrieve the character value.
`double`	`getDouble()` Retrieve the double value.
`float`	`getFloat()` Retrieve the float value.
`int`	`getInt()` Retrieve the integer value.
`long`	`getLong()` Retrieve the long value.
`short`	`getShort()` Retrieve the short value.
`java.lang.String`	`getString()` Retrieve the string value.
`java.lang.String`	`getType()` Retrieve the constant type.
`boolean`	`isFalse()` Determine if a constant is the false literal.
`boolean`	`isMinusOne()` Determine if a constant is a numeric literal whose value is -1.
`boolean`	`isNegative()` Determine if a constant is a numeric literal whose value is strictly negative.
`boolean`	`isNull()` Determine if the constant is the 'null' literal.
`boolean`	`isOne()` Determine if a constant is a numeric literal whose value is 1.
`boolean`	`isPositive()` Determine if a constant is a numeric literal whose value is strictly positive.
`boolean`	`isString()` Determine if the constant is of type `java.lang.String`.
`boolean`	`isTrue()` Determine if a constant is the true literal.
`boolean`	`isZero()` Determine if a constant is a numeric literal whose value is 0.

Methods inherited from class jeb.api.ast.NonStatement
attachTag, getSubElements, replaceSubElement, retrieveTag

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

Methods inherited from interface jeb.api.ast.IElement
attachTag, getSubElements, replaceSubElement, retrieveTag

- Method Detail
  - getType
```
public java.lang.String getType()
```
    Retrieve the constant type.
    
    Returns:
    
    the type signature, null if the constant is 'null'
    
    Since:
    
    1.4.201309040
  - isNull
```
public boolean isNull()
```
    Determine if the constant is the 'null' literal.
    
    Returns:
    
    true if the constant is 'null'
    
    Since:
    
    1.4.201309040
  - isString
```
public boolean isString()
```
    Determine if the constant is of type java.lang.String. Convenience routine.
    
    Returns:
    
    true if the constant is a Java string
    
    Since:
    
    1.4.201309040
  - getBoolean
```
public boolean getBoolean()
```
    Retrieve the boolean value.
    
    Returns:
    
    the value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a boolean
    
    Since:
    
    1.4.201309040
  - getByte
```
public byte getByte()
```
    Retrieve the byte value.
    
    Returns:
    
    the byte value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a byte
    
    Since:
    
    1.4.201309040
  - getChar
```
public char getChar()
```
    Retrieve the character value.
    
    Returns:
    
    the character value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a char
    
    Since:
    
    1.4.201309040
  - getShort
```
public short getShort()
```
    Retrieve the short value.
    
    Returns:
    
    the short value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a short
    
    Since:
    
    1.4.201309040
  - getInt
```
public int getInt()
```
    Retrieve the integer value.
    
    Returns:
    
    the integer value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not an int
    
    Since:
    
    1.4.201309040
  - getLong
```
public long getLong()
```
    Retrieve the long value.
    
    Returns:
    
    the long value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a long
    
    Since:
    
    1.4.201309040
  - getFloat
```
public float getFloat()
```
    Retrieve the float value.
    
    Returns:
    
    the float value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a float
    
    Since:
    
    1.4.201309040
  - getDouble
```
public double getDouble()
```
    Retrieve the double value.
    
    Returns:
    
    the double value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a double
    
    Since:
    
    1.4.201309040
  - getString
```
public java.lang.String getString()
```
    Retrieve the string value.
    
    Returns:
    
    the string value
    
    Throws:
    
    java.lang.IllegalStateException - if the constant is not a string
    
    Since:
    
    1.4.201309040
  - isTrue
```
public boolean isTrue()
```
    Determine if a constant is the true literal. This method does not raise.
    
    Returns:
    
    true if the constant is a boolean true, false otherwise
    
    Since:
    
    1.4.201309040
  - isFalse
```
public boolean isFalse()
```
    Determine if a constant is the false literal. This method does not raise.
    
    Returns:
    
    true if the constant is a boolean false, false otherwise
    
    Since:
    
    1.4.201309040
  - isZero
```
public boolean isZero()
```
    Determine if a constant is a numeric literal whose value is 0. This method does not raise.
    
    Returns:
    
    true if the constant is a numeric literal whose value is 0, false otherwise
    
    Since:
    
    1.4.201309040
  - isOne
```
public boolean isOne()
```
    Determine if a constant is a numeric literal whose value is 1. This method does not raise.
    
    Returns:
    
    true if the constant is a numeric literal whose value is 1, false otherwise
    
    Since:
    
    1.4.201309040
  - isMinusOne
```
public boolean isMinusOne()
```
    Determine if a constant is a numeric literal whose value is -1. This method does not raise.
    
    Returns:
    
    true if the constant is a numeric literal whose value is -1, false otherwise
    
    Since:
    
    1.4.201309040
  - isPositive
```
public boolean isPositive()
```
    Determine if a constant is a numeric literal whose value is strictly positive. This method does not raise.
    
    Returns:
    
    true if the constant is a numeric literal whose value is strictly positive, false otherwise
    
    Since:
    
    1.4.201309040
  - isNegative
```
public boolean isNegative()
```
    Determine if a constant is a numeric literal whose value is strictly negative. This method does not raise.
    
    Returns:
    
    true if the constant is a numeric literal whose value is strictly negative, false otherwise
    
    Since:
    
    1.4.201309040

Class Constant

Nested Class Summary

Method Summary

Methods inherited from class jeb.api.ast.NonStatement

Methods inherited from class java.lang.Object

Methods inherited from interface jeb.api.ast.IElement

Method Detail

getType

isNull

isString

getBoolean

getByte

getChar

getShort

getInt

getLong

getFloat

getDouble

getString

isTrue

isFalse

isZero

isOne

isMinusOne

isPositive

isNegative