ariba.util.core
Class Constants

java.lang.Object
  ariba.util.core.Constants

All Implemented Interfaces:

Externalizable, Serializable

public class Constants
extends Object
implements Externalizable

Constants for well known values

See Also:

Serialized Form

Field Summary

static String	BigDecimalType String constant for java.math.BigDecimal
static Constants	BlobNull
static String	BlobType String constant for ariba.util.Blob
static String	BooleanPrimitiveType String constant for char
static String	BooleanType String constant for java.lang.Boolean
static String	BytePrimitiveType String constant for byte
static String	CharPrimitiveType String constant for char
static Constants	DateNull
static Constants	DoubleNull
static String	DoublePrimitiveType String constant for double
static String	DoubleType String constant for java.lang.Double
static Object[]	EmptyArray Public constant for an empty array.
static String	EmptyString Public constant for an empty string
static String	FileType String constant for java.io.File
static String	FloatPrimitiveType String constant for float
static String	FloatType String constant for java.lang.Float
static boolean	Horizontally
static String	IntArrayType String constant for [I (jni)
static String	IntegerArrayType String constant for [Ljava.lang.Integer (jni)
static Constants	IntegerNull
static String	IntegerType String constant for java.lang.Integer
static String	IntPrimitiveType String constant for int
static String	JavaArrayAbbreviation
static String	JavaBooleanAbbreviation
static String	JavaByteAbbreviation
static String	JavaCharAbbreviation
static String	JavaDateType String constant for java.util.Date
static String	JavaDoubleAbbreviation
static String	JavaFloatAbbreviation
static String	JavaIntAbbreviation
static String	JavaLongAbbreviation
static String	JavaObjectAbbreviation
static String	JavaShortAbbreviation
static String	KeyConfigDirectoryProperty
static String	KeySystemDirectoryProperty
static String	KeyTempDirectoryProperty
static String	ListType String constant for java.util.List
static Constants	LongNull
static String	LongPrimitiveType String constant for long
static String	LongType String constant for java.lang.Long
static String	MapType String constant for java.util.Map
static Integer	MinusOneInteger Public constant for Integer(-1) to avoid object allocation
static Long	MinusOneLong Public constant for Long(-1) to avoid object allocation
static Object	NullObject Public constant for Object()
static Constants	NumberNull
static String	NumberType String constant for java.lang.Number
static String	ObjectType String constant for java.lang.Object
static BigDecimal	OneBigDecimal Public constant for BigDecimal(1.0) to avoid object allocation
static BigDecimal	OneHundredBigDecimal Public constant for BigDecimal(100.0) to avoid object allocation
static Integer	OneInteger Public constant for Integer(1) to avoid object allocation
static Long	OneLong Public constant for Long(1) to avoid object allocation
static String	ShortPrimitiveType String constant for int
static String	SQLDateType String constant for java.sql.Date
static String	StringNull Null String object.
static Constants	StringNullConstant
static int	StringNullId leave this decl first.
static String	StringType String constant for java.lang.String
static int	Success Where applicable some functions use the Success int constant return value.
static Integer	SuccessInteger Where applicable some functions use the Success Integer constant return value.
static BigDecimal	TenBigDecimal Public constant for BigDecimal(10.0) to avoid object allocation
static String	TimestampType String constant for java.sql.Timestamp
static String	URLType String constant for java.net.URL
static boolean	Vertically
static BigDecimal	ZeroBigDecimal Public constant for BigDecimal(0.0) to avoid object allocation
static Double	ZeroDouble Public constant for Double(0.0) to avoid object allocation
static Float	ZeroFloat Public constant for Float(0.0) to avoid object allocation
static Integer	ZeroInteger Public constant for Integer(0 to avoid object allocation
static Long	ZeroLong Public constant for Long(0) to avoid object allocation

Constructor Summary

Constants()
Implementation of Externalizable interface.

Method Summary

static Object	constantForId(int i)
static Boolean	getBoolean(boolean b) Helper function to generate Booleans without excess memory allocation.
static Boolean	getBoolean(String s) Parse a string into a Boolean.
static String	getDefaultConfigDir() The only other class that should this method is ariba.util.parameters.Parameters Everyone else should use SystemUtil.getConfigDirectoryString()
static String	getDefaultSystemDir() The only other class that should this method is ariba.util.parameters.Parameters Everyone else should use SystemUtil.getSystemDirectoryString()
static String	getDefaultTempDirectory() The only other class that should use this method is ariba.util.parameters.Parameters Everyone else should use SystemUtil.getLocalTempDirectoryString()
int	getId()
static Integer	getInteger(int i) Helper function to generate Integers without excess memory allocation.
static Long	getLong(long l) Helper function to create Long objects.
static File	getTempDirectory() Deprecated. use SystemUtil.getLocalTempDirectory
void	readExternal(ObjectInput input) Implementation of Externalizable interface.
void	writeExternal(ObjectOutput output) Implementation of Externalizable interface.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

StringNullId

public static final int StringNullId

leave this decl first. Otherwise strange things may happen.

See Also:

Constant Field Values

Horizontally

public static final boolean Horizontally

See Also:

Constant Field Values

Vertically

public static final boolean Vertically

See Also:

Constant Field Values

NumberNull

public static final Constants NumberNull

StringNull

public static final String StringNull

Null String object. It would be nice to use new String to guarantee a unique new object, but that gives us a tricky initialization ordering problem. So just make the string weird.

See Also:

Constant Field Values

StringNullConstant

public static final Constants StringNullConstant

DateNull

public static final Constants DateNull

IntegerNull

public static final Constants IntegerNull

DoubleNull

public static final Constants DoubleNull

BlobNull

public static final Constants BlobNull

LongNull

public static final Constants LongNull

ObjectType

public static final String ObjectType

String constant for java.lang.Object

StringType

public static final String StringType

String constant for java.lang.String

BooleanType

public static final String BooleanType

String constant for java.lang.Boolean

IntegerType

public static final String IntegerType

String constant for java.lang.Integer

LongType

public static final String LongType

String constant for java.lang.Long

FloatType

public static final String FloatType

String constant for java.lang.Float

DoubleType

public static final String DoubleType

String constant for java.lang.Double

NumberType

public static final String NumberType

String constant for java.lang.Number

BigDecimalType

public static final String BigDecimalType

String constant for java.math.BigDecimal

JavaDateType

public static final String JavaDateType

String constant for java.util.Date

SQLDateType

public static final String SQLDateType

String constant for java.sql.Date

TimestampType

public static final String TimestampType

String constant for java.sql.Timestamp

BlobType

public static final String BlobType

String constant for ariba.util.Blob

FileType

public static final String FileType

String constant for java.io.File

URLType

public static final String URLType

String constant for java.net.URL

ListType

public static final String ListType

String constant for java.util.List

MapType

public static final String MapType

String constant for java.util.Map

CharPrimitiveType

public static final String CharPrimitiveType

String constant for char

JavaCharAbbreviation

public static final String JavaCharAbbreviation

See Also:

Constant Field Values

BytePrimitiveType

public static final String BytePrimitiveType

String constant for byte

JavaByteAbbreviation

public static final String JavaByteAbbreviation

See Also:

Constant Field Values

ShortPrimitiveType

public static final String ShortPrimitiveType

String constant for int

JavaShortAbbreviation

public static final String JavaShortAbbreviation

See Also:

Constant Field Values

IntPrimitiveType

public static final String IntPrimitiveType

String constant for int

JavaIntAbbreviation

public static final String JavaIntAbbreviation

See Also:

Constant Field Values

LongPrimitiveType

public static final String LongPrimitiveType

String constant for long

JavaLongAbbreviation

public static final String JavaLongAbbreviation

See Also:

Constant Field Values

FloatPrimitiveType

public static final String FloatPrimitiveType

String constant for float

JavaFloatAbbreviation

public static final String JavaFloatAbbreviation

See Also:

Constant Field Values

DoublePrimitiveType

public static final String DoublePrimitiveType

String constant for double

JavaDoubleAbbreviation

public static final String JavaDoubleAbbreviation

See Also:

Constant Field Values

BooleanPrimitiveType

public static final String BooleanPrimitiveType

String constant for char

JavaBooleanAbbreviation

public static final String JavaBooleanAbbreviation

See Also:

Constant Field Values

JavaArrayAbbreviation

public static final String JavaArrayAbbreviation

See Also:

Constant Field Values

JavaObjectAbbreviation

public static final String JavaObjectAbbreviation

See Also:

Constant Field Values

IntegerArrayType

public static final String IntegerArrayType

String constant for [Ljava.lang.Integer (jni)

IntArrayType

public static final String IntArrayType

String constant for [I (jni)

MinusOneInteger

public static final Integer MinusOneInteger

Public constant for Integer(-1) to avoid object allocation

ZeroInteger

public static final Integer ZeroInteger

Public constant for Integer(0 to avoid object allocation

OneInteger

public static final Integer OneInteger

Public constant for Integer(1) to avoid object allocation

MinusOneLong

public static final Long MinusOneLong

Public constant for Long(-1) to avoid object allocation

ZeroLong

public static final Long ZeroLong

Public constant for Long(0) to avoid object allocation

OneLong

public static final Long OneLong

Public constant for Long(1) to avoid object allocation

ZeroFloat

public static final Float ZeroFloat

Public constant for Float(0.0) to avoid object allocation

ZeroDouble

public static final Double ZeroDouble

Public constant for Double(0.0) to avoid object allocation

ZeroBigDecimal

public static final BigDecimal ZeroBigDecimal

Public constant for BigDecimal(0.0) to avoid object allocation

OneBigDecimal

public static final BigDecimal OneBigDecimal

Public constant for BigDecimal(1.0) to avoid object allocation

TenBigDecimal

public static final BigDecimal TenBigDecimal

Public constant for BigDecimal(10.0) to avoid object allocation

OneHundredBigDecimal

public static final BigDecimal OneHundredBigDecimal

Public constant for BigDecimal(100.0) to avoid object allocation

NullObject

public static final Object NullObject

Public constant for Object()

EmptyString

public static final String EmptyString

Public constant for an empty string

See Also:

Constant Field Values

EmptyArray

public static final Object[] EmptyArray

Public constant for an empty array.

KeySystemDirectoryProperty

public static final String KeySystemDirectoryProperty

See Also:

Constant Field Values

KeyConfigDirectoryProperty

public static final String KeyConfigDirectoryProperty

See Also:

Constant Field Values

KeyTempDirectoryProperty

public static final String KeyTempDirectoryProperty

See Also:

Constant Field Values

Success

public static final int Success

Where applicable some functions use the Success int constant return value.

See Also:

Constant Field Values

SuccessInteger

public static final Integer SuccessInteger

Where applicable some functions use the Success Integer constant return value.

Constructor Detail

Constants

public Constants()

Implementation of Externalizable interface.

Method Detail

constantForId

public static Object constantForId(int i)

getId

public int getId()

getDefaultSystemDir

public static String getDefaultSystemDir()

The only other class that should this method is ariba.util.parameters.Parameters Everyone else should use SystemUtil.getSystemDirectoryString()

getDefaultConfigDir

public static String getDefaultConfigDir()

The only other class that should this method is ariba.util.parameters.Parameters Everyone else should use SystemUtil.getConfigDirectoryString()

getDefaultTempDirectory

public static String getDefaultTempDirectory()

The only other class that should use this method is ariba.util.parameters.Parameters Everyone else should use SystemUtil.getLocalTempDirectoryString()

getTempDirectory

public static File getTempDirectory()

Deprecated. use SystemUtil.getLocalTempDirectory

Gets the directory for storing temp files.

Returns:

directory for storing temp files

getBoolean

public static Boolean getBoolean(boolean b)

Helper function to generate Booleans without excess memory allocation.

Parameters:

b - the boolean value requested

Returns:

the constant Boolean for true or false as requested.

getBoolean

public static Boolean getBoolean(String s)

Parse a string into a Boolean. This assumes that the Boolean.toBoolean() method was used to create the String.

Parameters:

s - a String representation of a boolean

Returns:

Boolean.TRUE if the string was for the true boolean, Boolean.FALSE otherwise

getInteger

public static Integer getInteger(int i)

Helper function to generate Integers without excess memory allocation.

Parameters:

i - the integer value requested

Returns:

the corresponding Integer as requested.

getLong

public static Long getLong(long l)

Helper function to create Long objects. This will try to avoid allocating new Long objects on every invocation.

Parameters:

l - a long to convert into a Long

Returns:

a constant Long, occasionally from a pre-allocated set.

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Implementation of Externalizable interface.

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Implementation of Externalizable interface.

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException