com.xilinx.rapidwright.edif

Class EDIFPropertyObject

Object

com.xilinx.rapidwright.edif.EDIFName

com.xilinx.rapidwright.edif.EDIFPropertyObject

All Implemented Interfaces:

Comparable<EDIFName>

Direct Known Subclasses:

EDIFCell, EDIFCellInst, EDIFDesign, EDIFNet, EDIFPort

public class EDIFPropertyObject
extends EDIFName

All EDIF netlist objects that can possess properties inherit from this class. Created on: May 12, 2017

Constructor Summary

Constructors

Constructor and Description
EDIFPropertyObject(EDIFPropertyObject obj)
EDIFPropertyObject(String name)

Method Summary

Modifier and Type	Method and Description
void	addProperties(Map<EDIFName,EDIFPropertyValue> properties)
EDIFPropertyValue	addProperty(EDIFName key, EDIFPropertyValue value) Adds the property entry mapping for this object.
EDIFPropertyValue	addProperty(String key, boolean value) Convenience property creator for booleans
EDIFPropertyValue	addProperty(String key, int value) Convenience property creator for integers
EDIFPropertyValue	addProperty(String key, String value) Convenience property creator for string types
EDIFPropertyValue	addProperty(String key, String value, EDIFValueType type) Convenience property creator.
Map<EDIFName,EDIFPropertyValue>	createDuplicatePropertiesMap() Creates a completely new copy of the map
void	exportEDIFProperties(Writer wr, String indent)
String	getOwner()
Map<EDIFName,EDIFPropertyValue>	getProperties()
EDIFPropertyValue	getProperty(String key)
EDIFPropertyValue	removeProperty(String key) Convenience method to remove a property
void	setOwner(String owner)
void	setProperties(Map<EDIFName,EDIFPropertyValue> properties)

Methods inherited from class com.xilinx.rapidwright.edif.EDIFName

compareTo, equals, exportEDIFName, getLegalEDIFName, getName, getNewMap, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EDIFPropertyObject

public EDIFPropertyObject(String name)

EDIFPropertyObject

public EDIFPropertyObject(EDIFPropertyObject obj)

Method Detail

addProperty

public EDIFPropertyValue addProperty(String key,
                                     String value,
                                     EDIFValueType type)

Convenience property creator.

Parameters:

key - Key value (to be wrapped in an EDIFName)

value - The value of the property

type - The type of value (string, boolean, integer)

Returns:

The previous property value stored under the provided key

addProperty

public EDIFPropertyValue addProperty(String key,
                                     String value)

Convenience property creator for string types

Parameters:

key - Key value (to be wrapped in an EDIFName)

value - The value of the property

Returns:

The previous property value stored under the provided key

addProperty

public EDIFPropertyValue addProperty(String key,
                                     int value)

Convenience property creator for integers

Parameters:

key - Key value (to be wrapped in an EDIFName)

value - The value of the property

Returns:

The previous property value stored under the provided key

addProperty

public EDIFPropertyValue addProperty(String key,
                                     boolean value)

Convenience property creator for booleans

Parameters:

key - Key value (to be wrapped in an EDIFName)

value - The value of the property

Returns:

The previous property value stored under the provided key

removeProperty

public EDIFPropertyValue removeProperty(String key)

Convenience method to remove a property

Parameters:

key - Name of the property

Returns:

The old property value or null if none existed

addProperty

public EDIFPropertyValue addProperty(EDIFName key,
                                     EDIFPropertyValue value)

Adds the property entry mapping for this object.

Parameters:

key - Key entry for the property

value - Value entry for the property

Returns:

Old property value for the provided key

addProperties

public void addProperties(Map<EDIFName,EDIFPropertyValue> properties)

getProperty

public EDIFPropertyValue getProperty(String key)

getProperties

public Map<EDIFName,EDIFPropertyValue> getProperties()

Returns:

the properties

createDuplicatePropertiesMap

public Map<EDIFName,EDIFPropertyValue> createDuplicatePropertiesMap()

Creates a completely new copy of the map

Returns:

setProperties

public void setProperties(Map<EDIFName,EDIFPropertyValue> properties)

Parameters:

properties - the properties to set

exportEDIFProperties

public void exportEDIFProperties(Writer wr,
                                 String indent)
                          throws IOException

Throws:

IOException

getOwner

public String getOwner()

Returns:

the owner

setOwner

public void setOwner(String owner)

Parameters:

owner - the owner to set