byucc.edif
Class RenamedObject

java.lang.Object
  byucc.edif.NamedObject
      byucc.edif.RenamedObject

All Implemented Interfaces:

java.lang.Cloneable, EdifNameable, EdifOut, Nameable, java.io.Serializable

public class RenamedObject

extends NamedObject

implements java.lang.Cloneable, java.io.Serializable

Represents Edif names that are renamed using the RENAME keyword. This class actually contains two names: The first name is the "Edif" name that will be used by the EDIF infrastructure. This name is accessed/changed using the NamedObject super class methods. The second name is the "old name" or the origional name that was renamed. This is often an invalid EDIF name that required renaming for internal use. This object is immutable.

Sample Edif:

(rename diff_0 "diff(0)")
 

Version:

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

Author:

Welson Sun, Mike Wirthlin, Tyler Anderson

See Also:

Serialized Form

Field Summary

private java.lang.String

_oldname The old name that had to be renamed.

Fields inherited from class byucc.edif.NamedObject

Constructor Summary

RenamedObject(java.lang.String name, java.lang.String oldname)
Constructs an initialized RenamedObject.

Method Summary

java.lang.Object	clone() Provide a deep clone of this object.
static EdifNameable	createValidEdifNameable(java.lang.String string) This method will create a new EdifNameable object from the given string.
boolean	equals(java.lang.Object cmp) Compares this Object's name to the given Object.
java.lang.String	getOldName() Returns the old name.
void	toEdif(EdifPrintWriter epw) Converts this object to EDIF format, and writes it to the passed in EdifPrintWriter
java.lang.String	toString() Returns a String representation of this object.

Methods inherited from class byucc.edif.NamedObject

createValidEdifString, getName, isValidEdifName

Methods inherited from class java.lang.Object

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

Field Detail

_oldname

private java.lang.String _oldname

The old name that had to be renamed.

Constructor Detail

RenamedObject

public RenamedObject(java.lang.String name,
                     java.lang.String oldname)

Constructs an initialized RenamedObject.

Parameters:

name - The Edif name (new name)

oldname - The old original name that needed renaming

Method Detail

clone

public java.lang.Object clone()

Provide a deep clone of this object. New strings are created for the cloned object.

Specified by:

clone in interface EdifNameable

Overrides:

clone in class NamedObject

Returns:

An Object that is a copy of clone of this NamedObject

createValidEdifNameable

public static EdifNameable createValidEdifNameable(java.lang.String string)

This method will create a new EdifNameable object from the given string. The object will represent a valid Edif name. In this implementation, a NamedObject will be returned if the string is a valid Edif string. If an invalid string is passed in, a RenamedObject will be returned with the old invalid name stored in the old name field of the RenamedObject.

Parameters:

string - The string that will be used to make a valid and unique EDIF name

Returns:

And EdifNameable Object, containing the name, or new name and old name

equals

public boolean equals(java.lang.Object cmp)

Description copied from class: NamedObject

Compares this Object's name to the given Object.

Overrides:

equals in class NamedObject

Parameters:

cmp - The Object to compare to this one

Returns:

True if the name of this Object equals the name of the passed in one

getOldName

public java.lang.String getOldName()

Returns the old name.

Returns:

A String object containing the old name of this object before it was renamed

toEdif

public void toEdif(EdifPrintWriter epw)

Converts this object to EDIF format, and writes it to the passed in EdifPrintWriter

Specified by:

toEdif in interface EdifOut

Overrides:

toEdif in class NamedObject

Parameters:

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

toString

public java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class NamedObject

Returns:

a String object that represents this renamed object