IlvSingleValueNamedProperty (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.IlvNamedProperty
- - ilog.views.io.IlvSingleValueNamedProperty

All Implemented Interfaces:

IlvPersistentObject, Serializable
```
public class IlvSingleValueNamedProperty
extends IlvNamedProperty
implements Serializable
```
The class IlvSingleValueNamedProperty is a named property for general purpose that allows to store a simple single value. It can be used when it is necessary to save one value to an .ivl file, and this value is one of the following types: boolean, int, short, long, float, double, Boolean, Integer, Short, Long, Float, Double, String, Color, Font, IlvPoint, IlvRect, IlvTransformer, IlvPersistentObject, IlvGraphic, boolean[], int[], short[], long[], float[], double[], String[], Color[], Font[], IlvPoint[], IlvRect[], IlvTransformer[],IlvPersistentObject[], IlvIlvGraphic[]. Note that self cycles must be avoided, i.e. you cannot store a single value named property containing a graphic in that graphic itself.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvSingleValueNamedProperty(IlvInputStream stream)` Creates a new `IlvSingleValueNamedProperty` from an `IlvInputStream`.
`IlvSingleValueNamedProperty(IlvSingleValueNamedProperty source)` Creates a new `IlvSingleValueNamedProperty` by copying an existing one.
`IlvSingleValueNamedProperty(String name, boolean value)` Creates a new `IlvSingleValueNamedProperty`.
`IlvSingleValueNamedProperty(String name, double value)` Creates a new `IlvSingleValueNamedProperty`.
`IlvSingleValueNamedProperty(String name, float value)` Creates a new `IlvSingleValueNamedProperty`.
`IlvSingleValueNamedProperty(String name, int value)` Creates a new `IlvSingleValueNamedProperty`.
`IlvSingleValueNamedProperty(String name, long value)` Creates a new `IlvSingleValueNamedProperty`.
`IlvSingleValueNamedProperty(String name, Object value)` Creates a new `IlvSingleValueNamedProperty`.
`IlvSingleValueNamedProperty(String name, short value)` Creates a new `IlvSingleValueNamedProperty`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()` Returns the value stored in the named property, if the value is a `boolean`.
`IlvNamedProperty`	`copy()` Copies the named property.
`double`	`doubleValue()` Returns the value stored in the named property, if the value is a `double`.
`float`	`floatValue()` Returns the value stored in the named property, if the value is a `float`.
`Object`	`getValue()` Returns the value stored in the named property.
`int`	`intValue()` Returns the value stored in the named property, if the value is a `int`.
`boolean`	`isPersistent()` Returns `true` if the property must be saved to an .ivl file.
`long`	`longValue()` Returns the value stored in the named property, if the value is a `long`.
`void`	`setValue(boolean value)` Sets the value of the named property, if the value is `boolean`.
`void`	`setValue(double value)` Sets the value of the named property, if the value is `double`.
`void`	`setValue(float value)` Sets the value of the named property, if the value is `float`.
`void`	`setValue(int value)` Sets the value of the named property, if the value is `int`.
`void`	`setValue(long value)` Sets the value of the named property, if the value is `long`.
`void`	`setValue(Object value)` Sets the value of the named property.
`void`	`setValue(short value)` Sets the value of the named property, if the value is `short`.
`short`	`shortValue()` Returns the value stored in the named property, if the value is a `short`.
`void`	`write(IlvOutputStream stream)` Writes the property to the output stream.

Methods inherited from class ilog.views.IlvNamedProperty
getName

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

- Constructor Detail
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(String name,
                                   Object value)
```
    Creates a new IlvSingleValueNamedProperty. The value can be saved to an .ivl files if and only if it is one of those types: Boolean, Integer, Short, Long, Float, Double, String, Color, Font, IlvPoint, IlvRect, IlvTransformer, boolean[], int[], short[], long[], float[], double[], String[], Color[], Font[], IlvPoint[], IlvRect[], IlvTransformer[],IlvPersistentObject.
    
    Parameters:
    
    name - The name of the property.
    
    value - The value to be stored.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(String name,
                                   boolean value)
```
    Creates a new IlvSingleValueNamedProperty.
    
    Parameters:
    
    name - The name of the property.
    
    value - The value to be stored if it is a boolean.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(String name,
                                   short value)
```
    Creates a new IlvSingleValueNamedProperty.
    
    Parameters:
    
    name - The name of the property.
    
    value - The value to be stored if it is a short.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(String name,
                                   int value)
```
    Creates a new IlvSingleValueNamedProperty.
    
    Parameters:
    
    name - The name of the property.
    
    value - The value to be stored if it is a int.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(String name,
                                   long value)
```
    Creates a new IlvSingleValueNamedProperty.
    
    Parameters:
    
    name - The name of the property.
    
    value - The value to be stored if it is a long.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(String name,
                                   float value)
```
    Creates a new IlvSingleValueNamedProperty.
    
    Parameters:
    
    name - The name of the property.
    
    value - The value to be stored if it is a float.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(String name,
                                   double value)
```
    Creates a new IlvSingleValueNamedProperty.
    
    Parameters:
    
    name - The name of the property.
    
    value - The value to be stored if it is a double.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(IlvSingleValueNamedProperty source)
```
    Creates a new IlvSingleValueNamedProperty by copying an existing one.
    
    Parameters:
    
    source - The origin of the copy.
  - IlvSingleValueNamedProperty
```
public IlvSingleValueNamedProperty(IlvInputStream stream)
                            throws IOException,
                                   IlvReadFileException
```
    Creates a new IlvSingleValueNamedProperty from an IlvInputStream.
    
    Parameters:
    
    stream - The input stream from which the property must be read.
    
    Throws:
    
    IlvReadFileException - if an error occurs while reading.
    
    IOException
- Method Detail
  - setValue
```
public void setValue(Object value)
```
    Sets the value of the named property. The value can be saved to an .ivl files if and only if it is one of those types: Boolean, Integer, Short, Long, Float, Double, String, Color, Font, IlvPoint, IlvRect, IlvTransformer, IlvPersistentObject, IlvGraphic, boolean[], int[], short[], long[], float[], double[], String[], Color[], Font[], IlvPoint[], IlvRect[], IlvTransformer[],IlvPersistentObject[], IlvGraphic[].
  - setValue
```
public void setValue(boolean value)
```
    Sets the value of the named property, if the value is boolean.
  - setValue
```
public void setValue(short value)
```
    Sets the value of the named property, if the value is short.
  - setValue
```
public void setValue(int value)
```
    Sets the value of the named property, if the value is int.
  - setValue
```
public void setValue(long value)
```
    Sets the value of the named property, if the value is long.
  - setValue
```
public void setValue(float value)
```
    Sets the value of the named property, if the value is float.
  - setValue
```
public void setValue(double value)
```
    Sets the value of the named property, if the value is double.
  - getValue
```
public Object getValue()
```
    Returns the value stored in the named property.
  - booleanValue
```
public boolean booleanValue()
```
    Returns the value stored in the named property, if the value is a boolean. Throws a NullPointerException if the value was never set. Throws a ClassCastException if the value is not a boolean.
  - shortValue
```
public short shortValue()
```
    Returns the value stored in the named property, if the value is a short. Throws a NullPointerException if the value was never set. Throws a ClassCastException if the value is not a short.
  - intValue
```
public int intValue()
```
    Returns the value stored in the named property, if the value is a int. Throws a NullPointerException if the value was never set. Throws a ClassCastException if the value is not a int.
  - longValue
```
public long longValue()
```
    Returns the value stored in the named property, if the value is a long. Throws a NullPointerException if the value was never set. Throws a ClassCastException if the value is not a long.
  - floatValue
```
public float floatValue()
```
    Returns the value stored in the named property, if the value is a float. Throws a NullPointerException if the value was never set. Throws a ClassCastException if the value is not a float.
  - doubleValue
```
public double doubleValue()
```
    Returns the value stored in the named property, if the value is a double. Throws a NullPointerException if the value was never set. Throws a ClassCastException if the value is not a double.
  - copy
```
public IlvNamedProperty copy()
```
    Copies the named property.
    
    Specified by:
    
    copy in class IlvNamedProperty
  - isPersistent
```
public boolean isPersistent()
```
    Returns true if the property must be saved to an .ivl file.
    
    Specified by:
    
    isPersistent in class IlvNamedProperty
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the property to the output stream.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Overrides:
    
    write in class IlvNamedProperty
    
    Parameters:
    
    stream - The output stream.
    
    Throws:
    
    IOException - standard IO error.

Class IlvSingleValueNamedProperty

Constructor Summary

Method Summary

Methods inherited from class ilog.views.IlvNamedProperty

Methods inherited from class java.lang.Object

Constructor Detail

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

IlvSingleValueNamedProperty

Method Detail

setValue

setValue

setValue

setValue

setValue

setValue

setValue

getValue

booleanValue

shortValue

intValue

longValue

floatValue

doubleValue

copy

isPersistent

write