byucc.edif
Class Property

java.lang.Object
  byucc.edif.Property

All Implemented Interfaces:

EdifOut, java.io.Serializable

public class Property
extends java.lang.Object
implements EdifOut, java.io.Serializable

Specifies a String name/value pair to describe an EDIF property. The Property name defines the name of a given property and the value defines the actual value assigned to the property.

Version:

$Id: Property.java,v 1.14 2004/08/27 19:16:42 tsa6 Exp $

Author:

Welson Sun, Tyler Anderson

See Also:

Serialized Form

Field Summary

private java.lang.String	_name The actual String name of the property
private NewTypedValue	_value The actual String value of the property

Constructor Summary

Property(java.lang.String setName, boolean bool)
Constructs a Property Object with the specified name, and value as a BooleanTypedValue.

Property(java.lang.String setName, EdifNumber num)
Constructs a Property Object with the specified name, and value as a NumberTypedValue.

Property(java.lang.String setName, int i)
Constructs a Property Object with the specified name, and value as an IntegerTypedValue.

Property(java.lang.String setName, NewTypedValue setValue)
Constructs a Property Object with the specified name, and value as a NewTypedValue.

Property(java.lang.String setName, java.lang.String str)
Constructs a Property Object with the specified name, and value as a StringTypedValue.

Method Summary

java.lang.Object	clone() Clones this Property Object, and returns a clone of it.
boolean	equals(Property p) Returns True if this Property matches the passed-in one, making sure they are the same type, value, ect.
boolean	existsWithin(java.util.Map properties) Returns True if this Property Object matches with one of the Objects in the passed-in Map Object.
java.lang.String	getName() Returns the name of this Object.
NewTypedValue	getValue() Returns the typed value of this object.
void	setValue(NewTypedValue val) Sets the typed value of this object.
void	toEdif(EdifPrintWriter epw) Converts this Property Object to EDIF format and writes it to the passed-in EdifPrintWriter Object.
java.lang.String	toString() Returns a String representation of this object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_name

private java.lang.String _name

The actual String name of the property

_value

private NewTypedValue _value

The actual String value of the property

Constructor Detail

Property

public Property(java.lang.String setName,
                NewTypedValue setValue)

Constructs a Property Object with the specified name, and value as a NewTypedValue.

Parameters:

setName - The name of this new Property Object

setValue - The value of this new Property Object

Property

public Property(java.lang.String setName,
                java.lang.String str)

Constructs a Property Object with the specified name, and value as a StringTypedValue.

Parameters:

setName - The name of this new Property Object

str - The String value of this new Property Object

Property

public Property(java.lang.String setName,
                boolean bool)

Constructs a Property Object with the specified name, and value as a BooleanTypedValue.

Parameters:

setName - The name of this new Property Object

bool - The boolean value of this new Property Object

Property

public Property(java.lang.String setName,
                int i)

Constructs a Property Object with the specified name, and value as an IntegerTypedValue.

Parameters:

setName - The name of this new Property Object

i - The integer value of this new Property Object

Property

public Property(java.lang.String setName,
                EdifNumber num)

Constructs a Property Object with the specified name, and value as a NumberTypedValue.

Parameters:

setName - The name of this new Property Object

num - The EdifNumber value of this new Property Object

Method Detail

clone

public java.lang.Object clone()

Clones this Property Object, and returns a clone of it.

Overrides:

clone in class java.lang.Object

Returns:

An Object that is a clone of this Property Object

equals

public boolean equals(Property p)

Returns True if this Property matches the passed-in one, making sure they are the same type, value, ect.

Parameters:

p - The Property Object to compare this one to

Returns:

True if this Property Object matches the passed-in one

existsWithin

public boolean existsWithin(java.util.Map properties)

Returns True if this Property Object matches with one of the Objects in the passed-in Map Object. The Property's name is used as key.

Parameters:

properties - A list of properties to match against with this one

Returns:

True if this Property Object matches with one of the Property Objects contained in the passed-in Map Object

getName

public java.lang.String getName()

Returns the name of this Object.

Returns:

A String Object representing the name of this Property Object.

getValue

public NewTypedValue getValue()

Returns the typed value of this object.

Returns:

A NewTypedValue Object representing the typed value of this Property Object

setValue

public void setValue(NewTypedValue val)

Sets the typed value of this object.

Parameters:

val - The new typed value of this object

toEdif

public void toEdif(EdifPrintWriter epw)

Converts this Property Object to EDIF format and writes it to the passed-in EdifPrintWriter Object.

Specified by:

toEdif in interface EdifOut

Parameters:

epw - The EdifPrintWriter Object that the EDIF will be written to.

toString

public java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

A String object representing this Property Object.