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

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	EXPORT_CONST_OWNER_END
static byte[]	EXPORT_CONST_OWNER_START
static byte[]	EXPORT_CONST_PROP_END
static byte[]	EXPORT_CONST_PROP_START

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

EXPORT_CONST_RENAME_START

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EDIFPropertyValue	addProperty(String key, boolean value) Convenience property creator for booleans
EDIFPropertyValue	addProperty(String key, EDIFPropertyValue value) Adds the property entry mapping for this object.
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<String,EDIFPropertyValue>	createDuplicatePropertiesMap() Creates a completely new copy of the properties (with copied values).
void	exportEDIFProperties(OutputStream os, byte[] indent, EDIFWriteLegalNameCache<?> cache, boolean stable)
EDIFPropertyValue	getIOStandard() Helper method to get the IOStandard property, with consideration for an upper-case key name.
Map<String,EDIFPropertyValue>	getPropertiesMap() Get all properties in native format.
EDIFPropertyValue	getProperty(String key)
int	getPropertyCount() Gets the number of properties on this object without materializing a map.
EDIFPropertyValue	removeProperty(String key) Convenience method to remove a property
void	setPropertiesMap(Map<String,EDIFPropertyValue> properties) Set all properties.

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

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXPORT_CONST_PROP_START

public static final byte[] EXPORT_CONST_PROP_START

EXPORT_CONST_OWNER_START

public static final byte[] EXPORT_CONST_OWNER_START

EXPORT_CONST_OWNER_END

public static final byte[] EXPORT_CONST_OWNER_END

EXPORT_CONST_PROP_END

public static final byte[] EXPORT_CONST_PROP_END

Constructor Detail

EDIFPropertyObject

public EDIFPropertyObject(String name)

EDIFPropertyObject

public EDIFPropertyObject(EDIFPropertyObject obj)

Method Detail

getIOStandard

public EDIFPropertyValue getIOStandard()

Helper method to get the IOStandard property, with consideration for an upper-case key name.

Returns:

EDIFPropertyValue describing its IOStandard. Returns EDIFNetlist.DEFAULT_PROP_VALUE if no value found.

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(String 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

getProperty

public EDIFPropertyValue getProperty(String key)

getPropertyCount

public int getPropertyCount()

Gets the number of properties on this object without materializing a map.

Returns:

The number of properties.

createDuplicatePropertiesMap

public Map<String,EDIFPropertyValue> createDuplicatePropertiesMap()

Creates a completely new copy of the properties (with copied values).

Returns:

A new map of the properties, or null if this object has none.

getPropertiesMap

public Map<String,EDIFPropertyValue> getPropertiesMap()

Get all properties in native format. Returns a live Map view over this object's inlined property storage (mutations write through). An empty, immutable map is returned when this object has no properties.

setPropertiesMap

public void setPropertiesMap(Map<String,EDIFPropertyValue> properties)

Set all properties. The entries of the provided map are copied into this object's inlined storage (the map reference itself is not retained).

The provided map is read in full before this object's existing storage is replaced, so it is safe to pass this object's own live EDIFPropertyObject.getPropertiesMap() view (it is detected and treated as a no-op).

Parameters:

properties - the properties to set

exportEDIFProperties

public void exportEDIFProperties(OutputStream os,
                                 byte[] indent,
                                 EDIFWriteLegalNameCache<?> cache,
                                 boolean stable)
                          throws IOException

Throws:

IOException