hep.graphics.heprep
Interface HepRepAttValue

All Superinterfaces:
HepRepConstants

public interface HepRepAttValue
extends HepRepConstants

HepRepAttValue interface.

Author:
Mark Donszelmann

Field Summary
 
Fields inherited from interface hep.graphics.heprep.HepRepConstants
SHOW_DESC, SHOW_EXTRA, SHOW_NAME, SHOW_NONE, SHOW_VALUE, TYPE_BOOLEAN, TYPE_COLOR, TYPE_DOUBLE, TYPE_INT, TYPE_LONG, TYPE_STRING, TYPE_UNKNOWN
 
Method Summary
 HepRepAttValue copy()
          Returns a deep copy of this attvalue.
 String getAsString()
          Returns value as string.
 boolean getBoolean()
          Returns value as boolean.
 Color getColor()
          Returns value as Color.
 double getDouble()
          Returns value as double.
 int getInteger()
          Returns value as int.
 long getLong()
          Returns value as long.
 String getLowerCaseName()
          Returns lowercased name of the attvalue.
 String getLowerCaseString()
          Returns value as lowercase string.
 String getName()
          Returns name of the attvalue.
 String getString()
          Returns value as string.
 int getType()
          Returns type of the attvalue, defined in HepRepConstants with names TYPE_xxx.
 String getTypeName()
          Returns the Java-like name for the type of this attvalue.
 int showLabel()
          Returns the flag bits for showing this attvalue as a label, defined in HepRepConstants with names SHOW_xxx.
 

Method Detail

getName

String getName()
Returns name of the attvalue.

Returns:
Capitalized Name.

getLowerCaseName

String getLowerCaseName()
Returns lowercased name of the attvalue.

Returns:
Lowercased Name.

getType

int getType()
Returns type of the attvalue, defined in HepRepConstants with names TYPE_xxx.

Returns:
type.

getTypeName

String getTypeName()
Returns the Java-like name for the type of this attvalue.

Returns:
type name.

showLabel

int showLabel()
Returns the flag bits for showing this attvalue as a label, defined in HepRepConstants with names SHOW_xxx.

Returns:
flag bits if should be shown as label.

getString

String getString()
                 throws HepRepTypeException
Returns value as string.

Returns:
value as string (if type is string).
Throws:
HepRepTypeException - if type is not string.

getLowerCaseString

String getLowerCaseString()
                          throws HepRepTypeException
Returns value as lowercase string.

Returns:
value as string (if type is string).
Throws:
HepRepTypeException - if type is not string.

getAsString

String getAsString()
Returns value as string.

Returns:
value (of any type) in string format.

getColor

Color getColor()
               throws HepRepTypeException
Returns value as Color.

Returns:
value as Color.
Throws:
HepRepTypeException - if type is not Color.

getLong

long getLong()
             throws HepRepTypeException
Returns value as long.

Returns:
value as long.
Throws:
HepRepTypeException - if type is not long.

getInteger

int getInteger()
               throws HepRepTypeException
Returns value as int.

Returns:
value as integer.
Throws:
HepRepTypeException - if type is not int.

getDouble

double getDouble()
                 throws HepRepTypeException
Returns value as double.

Returns:
value as double.
Throws:
HepRepTypeException - if type is not double.

getBoolean

boolean getBoolean()
                   throws HepRepTypeException
Returns value as boolean.

Returns:
value as boolean.
Throws:
HepRepTypeException - if type is not boolean.

copy

HepRepAttValue copy()
                    throws CloneNotSupportedException
Returns a deep copy of this attvalue.

Returns:
copy of this attvalue.
Throws:
CloneNotSupportedException - if copying is not possible.


Copyright © 2000-2007 FreeHEP. All Rights Reserved.