|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.electric.database.ImmutableElectricObject
com.sun.electric.database.ImmutableExport
public class ImmutableExport
Immutable class ImmutableExport represents an export.
Field Summary | |
---|---|
boolean |
alwaysDrawn
True if this ImmutableExport to be always drawn. |
boolean |
bodyOnly
True to exclude this ImmutableExport from the icon. |
PortCharacteristic |
characteristic
PortCharacteristic of this ImmutableExport. |
static ImmutableArrayList<ImmutableExport> |
EMPTY_LIST
|
ExportId |
exportId
id of this Export. |
Name |
name
name of this ImmutableExport. |
TextDescriptor |
nameDescriptor
The text descriptor of name of ImmutableExport. |
static ImmutableExport[] |
NULL_ARRAY
|
int |
originalNodeId
The nodeId of original PortInst. |
PortProtoId |
originalPortId
The PortProtoId of orignal PortInst. |
Fields inherited from class com.sun.electric.database.ImmutableElectricObject |
---|
flags |
Method Summary | |
---|---|
static boolean |
alwaysDrawnFromElib(int elibBits)
Get alwaysDrawn Export flag from ELIB user bits. |
static boolean |
bodyOnlyFromElib(int elibBits)
Get bodyOnly Export flag from ELIB user bits. |
void |
check()
Checks invariant of this ImmutableExport. |
boolean |
equalsExceptVariables(ImmutableElectricObject o)
Indicates whether fields of other ImmutableElectricObject are equal to fileds of this object. |
int |
getElibBits()
Returns ELIB user bits of this ImmutableExport. |
int |
hashCodeExceptVariables()
Return a hash code value for fields of this object. |
static ImmutableExport |
newInstance(ExportId exportId,
Name name,
TextDescriptor nameDescriptor,
int originalNodeId,
PortProtoId originalPortId,
boolean alwaysDrawn,
boolean bodyOnly,
PortCharacteristic characteristic)
Returns new ImmutableExport object. |
static PortCharacteristic |
portCharacteristicFromElib(int elibBits)
Get PortCharacteristic of Export from ELIB user bits. |
static Name |
validExportName(java.lang.String name,
boolean busAllowed)
Returns name key of string if string is a valid Export name, null if not. |
ImmutableExport |
withAlwaysDrawn(boolean alwaysDrawn)
Returns ImmutableExport which differs from this ImmutableExport by alwaysDrawn flag. |
ImmutableExport |
withBodyOnly(boolean bodyOnly)
Returns ImmutableExport which differs from this ImmutableExport by bodyOnly flag. |
ImmutableExport |
withCharacteristic(PortCharacteristic characteristic)
Returns ImmutableExport which differs from this ImmutableExport by port characteristic. |
ImmutableExport |
withName(Name name)
Returns ImmutableExport which differs from this ImmutableExport by name. |
ImmutableExport |
withNameDescriptor(TextDescriptor nameDescriptor)
Returns ImmutableExport which differs from this ImmutableExport by name descriptor. |
ImmutableExport |
withOriginalPort(int originalNodeId,
PortProtoId originalPortId)
Returns ImmutableExport which differs from this ImmutableExport by original port. |
ImmutableExport |
withoutVariable(Variable.Key key)
Returns ImmutableExport which differs from this ImmutableExport by removing Variable with the specified key. |
ImmutableExport |
withVariable(Variable var)
Returns ImmutableExport which differs from this ImmutableExport by additional Variable. |
Methods inherited from class com.sun.electric.database.ImmutableElectricObject |
---|
getNumVariables, getVar, getVar, getVariables, getVarValue, searchVar, toVariableArray |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ImmutableExport[] NULL_ARRAY
public static final ImmutableArrayList<ImmutableExport> EMPTY_LIST
public final ExportId exportId
public final Name name
public final TextDescriptor nameDescriptor
public final int originalNodeId
public final PortProtoId originalPortId
public final boolean alwaysDrawn
public final boolean bodyOnly
public final PortCharacteristic characteristic
Method Detail |
---|
public static ImmutableExport newInstance(ExportId exportId, Name name, TextDescriptor nameDescriptor, int originalNodeId, PortProtoId originalPortId, boolean alwaysDrawn, boolean bodyOnly, PortCharacteristic characteristic)
exportId
- id of new Export.name
- name of new ImmutableExport.nameDescriptor
- TextDescriptor of name of this ImmutableExport.originalNodeId
- node id of original PortInst.originalPortId
- port proto id of original PortInst.alwaysDrawn
- true if new ImmutableExport is always drawn.bodyOnly
- true to exclude new ImmutableExport from the icon.characteristic
- PortCharacteristic of new ImmutableExport.
java.lang.NullPointerException
- if exportId, name, originalPortId is null.
java.lang.IllegalArgumentException
- if originalNodeId is bad.public ImmutableExport withName(Name name)
name
- export name key.
java.lang.NullPointerException
- if name is nullpublic ImmutableExport withNameDescriptor(TextDescriptor nameDescriptor)
nameDescriptor
- TextDescriptor of name
public ImmutableExport withOriginalPort(int originalNodeId, PortProtoId originalPortId)
originalNodeId
- node id of original PortInst.originalPortId
- port proto id of original PortInst.
java.lang.NullPointerException
- if originalPortId is null.public ImmutableExport withAlwaysDrawn(boolean alwaysDrawn)
alwaysDrawn
- true if new ImmutableExport is always drawn.
public ImmutableExport withBodyOnly(boolean bodyOnly)
bodyOnly
- true to exclude new ImmutableExport from the icon.
public ImmutableExport withCharacteristic(PortCharacteristic characteristic)
characteristic
- PortCharacteristic of new ImmutableExport.
public ImmutableExport withVariable(Variable var)
var
- additional Variable.
java.lang.NullPointerException
- if var is nullpublic ImmutableExport withoutVariable(Variable.Key key)
key
- Variable Key to remove.
java.lang.NullPointerException
- if key is nullpublic int getElibBits()
public static boolean alwaysDrawnFromElib(int elibBits)
elibBits
- ELIB user bits.
public static boolean bodyOnlyFromElib(int elibBits)
elibBits
- ELIB user bits.
public static PortCharacteristic portCharacteristicFromElib(int elibBits)
elibBits
- ELIB user bits.
public int hashCodeExceptVariables()
hashCodeExceptVariables
in class ImmutableElectricObject
public boolean equalsExceptVariables(ImmutableElectricObject o)
equalsExceptVariables
in class ImmutableElectricObject
o
- other ImmutableElectricObject.
public static Name validExportName(java.lang.String name, boolean busAllowed)
name
- string to test.busAllowed
- true of arrayed export name is allowed
public void check()
java.lang.AssertionError
- if invariant is broken.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |