Primitive

java.lang.Object
- bsh.Primitive

All Implemented Interfaces:

java.io.Serializable
```
public final class Primitive
extends java.lang.Object
implements java.io.Serializable
```
Wrapper for primitive types in Bsh. This is package public because it is used in the implementation of some bsh commands.

See the note in LHS.java about wrapping objects.

Author:

Pat Niemeyer, Daniel Leuck

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Primitive`	`FALSE`
`static Primitive`	`NULL`
`static Primitive`	`TRUE`
`static Primitive`	`VOID` VOID means "no type".
`static Primitive`	`ZERO_BIG_DECIMAL`
`static Primitive`	`ZERO_BIG_INTEGER`
`static Primitive`	`ZERO_BYTE`
`static Primitive`	`ZERO_CHAR` Default zero value constants
`static Primitive`	`ZERO_DOUBLE`
`static Primitive`	`ZERO_FLOAT`
`static Primitive`	`ZERO_INT`
`static Primitive`	`ZERO_LONG`
`static Primitive`	`ZERO_SHORT`

Constructor Summary

Constructors
Constructor and Description
`Primitive(java.math.BigDecimal value)`
`Primitive(java.math.BigInteger value)`
`Primitive(boolean value)`
`Primitive(byte value)`
`Primitive(char value)`
`Primitive(double value)`
`Primitive(float value)`
`Primitive(int value)`
`Primitive(long value)`
`Primitive(short value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.Class<?>`	`boxType(java.lang.Class<?> primitiveType)` Get the corresponding java.lang wrapper class for the primitive TYPE class.
`Primitive`	`castToType(java.lang.Class<?> toType, int operation)` Cast this bsh.Primitive value to a new bsh.Primitive value This is usually a numeric type cast.
`boolean`	`equals(java.lang.Object obj)` Primitives compare equal with other Primitives containing an equal wrapped value.
`static Primitive`	`getDefaultValue(java.lang.Class<?> type)` Get the appropriate default value per JLS 4.5.4
`java.lang.Class<?>`	`getType()` Get the corresponding Java primitive TYPE class for this Primitive.
`java.lang.Object`	`getValue()` Return the primitive value stored in its java.lang wrapper class
`int`	`hashCode()` The hash of the Primitive is tied to the hash of the wrapped value but shifted so that they are not the same.
`boolean`	`isNumber()` Determine if this primitive is a numeric type.
`static boolean`	`isWrapperType(java.lang.Class<?> type)`
`java.lang.Number`	`numberValue()`
`static Primitive`	`shrinkWrap(java.lang.Object number)`
`java.lang.String`	`toString()`
`static java.lang.Class<?>`	`unboxType(java.lang.Class<?> wrapperType)` Get the corresponding primitive TYPE class for the java.lang wrapper class type.
`static java.lang.Object`	`unwrap(java.lang.Object obj)` Unwrap primitive values and map voids to nulls.
`static java.lang.Object[]`	`unwrap(java.lang.Object[] args)`
`static java.lang.Object[]`	`wrap(java.lang.Object[] args, java.lang.Class<?>[] paramTypes)`
`static java.lang.Object`	`wrap(java.lang.Object value, java.lang.Class<?> type)` Wrap primitive values (as indicated by type param) and nulls in the Primitive class.

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

- Field Detail
  - TRUE
```
public static final Primitive TRUE
```
  - FALSE
```
public static final Primitive FALSE
```
  - ZERO_CHAR
```
public static final Primitive ZERO_CHAR
```
    Default zero value constants
  - ZERO_BYTE
```
public static final Primitive ZERO_BYTE
```
  - ZERO_SHORT
```
public static final Primitive ZERO_SHORT
```
  - ZERO_INT
```
public static final Primitive ZERO_INT
```
  - ZERO_LONG
```
public static final Primitive ZERO_LONG
```
  - ZERO_FLOAT
```
public static final Primitive ZERO_FLOAT
```
  - ZERO_DOUBLE
```
public static final Primitive ZERO_DOUBLE
```
  - ZERO_BIG_INTEGER
```
public static final Primitive ZERO_BIG_INTEGER
```
  - ZERO_BIG_DECIMAL
```
public static final Primitive ZERO_BIG_DECIMAL
```
  - NULL
```
public static final Primitive NULL
```
  - VOID
```
public static final Primitive VOID
```
    VOID means "no type". Strictly speaking, this makes no sense here. But for practical reasons we'll consider the lack of a type to be a special value.
- Constructor Detail
  - Primitive
```
public Primitive(boolean value)
```
  - Primitive
```
public Primitive(byte value)
```
  - Primitive
```
public Primitive(short value)
```
  - Primitive
```
public Primitive(char value)
```
  - Primitive
```
public Primitive(int value)
```
  - Primitive
```
public Primitive(long value)
```
  - Primitive
```
public Primitive(float value)
```
  - Primitive
```
public Primitive(double value)
```
  - Primitive
```
public Primitive(java.math.BigInteger value)
```
  - Primitive
```
public Primitive(java.math.BigDecimal value)
```
- Method Detail
  - getValue
```
public java.lang.Object getValue()
```
    Return the primitive value stored in its java.lang wrapper class
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getType
```
public java.lang.Class<?> getType()
```
    Get the corresponding Java primitive TYPE class for this Primitive.
    
    Returns:
    
    the primitive TYPE class type of the value or Void.TYPE for Primitive.VOID or null value for type of Primitive.NULL
  - shrinkWrap
```
public static Primitive shrinkWrap(java.lang.Object number)
```
  - isNumber
```
public boolean isNumber()
```
    Determine if this primitive is a numeric type. i.e. not boolean, null, or void (but including char)
  - numberValue
```
public java.lang.Number numberValue()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Primitives compare equal with other Primitives containing an equal wrapped value.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    The hash of the Primitive is tied to the hash of the wrapped value but shifted so that they are not the same.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - unwrap
```
public static java.lang.Object unwrap(java.lang.Object obj)
```
    Unwrap primitive values and map voids to nulls. Non Primitive types remain unchanged.
    
    Parameters:
    
    obj - object type which may be bsh.Primitive
    
    Returns:
    
    corresponding "normal" Java type, "unwrapping" any bsh.Primitive types to their wrapper types.
  - unwrap
```
public static java.lang.Object[] unwrap(java.lang.Object[] args)
```
  - wrap
```
public static java.lang.Object[] wrap(java.lang.Object[] args,
                                      java.lang.Class<?>[] paramTypes)
```
  - wrap
```
public static java.lang.Object wrap(java.lang.Object value,
                                    java.lang.Class<?> type)
```
    Wrap primitive values (as indicated by type param) and nulls in the Primitive class. Values not primitive or null are left unchanged. Primitive values are represented by their wrapped values in param value.
    The value null is mapped to Primitive.NULL. Any value specified with type Void.TYPE is mapped to Primitive.VOID.
  - getDefaultValue
```
public static Primitive getDefaultValue(java.lang.Class<?> type)
```
    Get the appropriate default value per JLS 4.5.4
  - boxType
```
public static java.lang.Class<?> boxType(java.lang.Class<?> primitiveType)
```
    Get the corresponding java.lang wrapper class for the primitive TYPE class. e.g. Integer.TYPE -> Integer.class
  - unboxType
```
public static java.lang.Class<?> unboxType(java.lang.Class<?> wrapperType)
```
    Get the corresponding primitive TYPE class for the java.lang wrapper class type. e.g. Integer.class -> Integer.TYPE
  - castToType
```
public Primitive castToType(java.lang.Class<?> toType,
                            int operation)
                     throws UtilEvalError
```
    Cast this bsh.Primitive value to a new bsh.Primitive value This is usually a numeric type cast. Other cases include: A boolean can be cast to boolen null can be cast to any object type and remains null Attempting to cast a void causes an exception
    
    Parameters:
    
    toType - is the java object or primitive TYPE class
    
    Throws:
    
    UtilEvalError
  - isWrapperType
```
public static boolean isWrapperType(java.lang.Class<?> type)
```

Class Primitive

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRUE

FALSE

ZERO_CHAR

ZERO_BYTE

ZERO_SHORT

ZERO_INT

ZERO_LONG

ZERO_FLOAT

ZERO_DOUBLE

ZERO_BIG_INTEGER

ZERO_BIG_DECIMAL

NULL

VOID

Constructor Detail

Primitive

Primitive

Primitive

Primitive

Primitive

Primitive

Primitive

Primitive

Primitive

Primitive

Method Detail

getValue

toString

getType

shrinkWrap

isNumber

numberValue

equals

hashCode

unwrap

unwrap

wrap

wrap

getDefaultValue

boxType

unboxType

castToType

isWrapperType