org.fulib.yaml

Class YamlIdMap

java.lang.Object

org.fulib.yaml.IdMap

org.fulib.yaml.YamlIdMap

public class YamlIdMap
extends IdMap

Field Summary

Fields inherited from class org.fulib.yaml.IdMap

idObjMap, maxUsedIdNum, objIdMap, reflectorMap, userId

Constructor Summary

Constructors

Constructor and Description
YamlIdMap(java.util.Collection<java.lang.String> packageNames)
YamlIdMap(ReflectorMap reflectorMap)
YamlIdMap(java.lang.String... packageNames)
YamlIdMap(java.lang.String packageName)

Method Summary

Modifier and Type	Method and Description
java.util.LinkedHashSet<java.lang.Object>	collectObjects(java.lang.Object... roots) Deprecated. since 1.2; use IdMap.discoverObjects(Object...) instead (unless the resulting set is needed)
java.lang.Object	decode(java.lang.String yaml)
java.lang.Object	decode(java.lang.String yaml, java.lang.Object root)
java.lang.Object	decodeCSV(java.lang.String fileName)
java.lang.String	encode() Encodes this IdMap to a Yaml string.
java.lang.String	encode(java.lang.Object... roots) Encodes this IdMap to a Yaml string.
void	encodeAttrValue(java.lang.StringBuilder buf, java.lang.Object obj, java.lang.String propertyName, java.lang.Object value) Deprecated. since 1.2; unused
java.lang.String	getAttributeTimeStamp(java.lang.String attribute)
java.util.HashMap<java.lang.String,java.lang.String>	getAttrTimeStamps() Deprecated. since 1.2; use getAttributeTimeStamp(String) instead
java.util.LinkedHashMap<java.lang.Object,java.lang.String>	getIdObjMap() Deprecated. since 1.2; use IdMap.getId(Object) instead
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getLastTimeStampMap() Deprecated. since 1.2; unused
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getLastTimeStampMap(java.lang.String lastTimeStamps) Deprecated. since 1.2; unused
java.lang.String	getLastTimeStamps() Deprecated. since 1.2; unused
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	getObjIdMap() Deprecated. since 1.2; use IdMap.getObject(String) instead
java.lang.String	getOrCreateKey(java.lang.Object obj) Deprecated. since 1.2; use IdMap.putObject(Object) instead
java.lang.String	getYamlChange()
boolean	isDecodingPropertyChange()
YamlIdMap	putNameObject(java.lang.String id, java.lang.Object object) Deprecated. since 1.2; use IdMap.putObject(String, Object) and IdMap.discoverObjects(Object) instead
void	setDecodingPropertyChange(boolean decodingPropertyChange)
YamlIdMap	withUserId(java.lang.String userId) Deprecated. since 1.2; use IdMap.setUserId(String) instead

Methods inherited from class org.fulib.yaml.IdMap

discoverObjects, discoverObjects, discoverObjects, getId, getObject, getReflector, getUserId, putObject, putObject, setUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlIdMap

public YamlIdMap(java.lang.String packageName)

Parameters:

packageName - the names of the package in which model classes reside

Since:

1.2

YamlIdMap

public YamlIdMap(java.lang.String... packageNames)

Parameters:

packageNames - the names of the packages in which model classes reside

YamlIdMap

public YamlIdMap(java.util.Collection<java.lang.String> packageNames)

Parameters:

packageNames - the names of the packages in which model classes reside

Since:

1.2

YamlIdMap

public YamlIdMap(ReflectorMap reflectorMap)

Since:

1.2

Method Detail

getObjIdMap

@Deprecated
public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getObjIdMap()

Deprecated. since 1.2; use IdMap.getObject(String) instead

getIdObjMap

@Deprecated
public java.util.LinkedHashMap<java.lang.Object,java.lang.String> getIdObjMap()

Deprecated. since 1.2; use IdMap.getId(Object) instead

getAttrTimeStamps

@Deprecated
public java.util.HashMap<java.lang.String,java.lang.String> getAttrTimeStamps()

Deprecated. since 1.2; use getAttributeTimeStamp(String) instead

withUserId

@Deprecated
public YamlIdMap withUserId(java.lang.String userId)

Deprecated. since 1.2; use IdMap.setUserId(String) instead

isDecodingPropertyChange

public boolean isDecodingPropertyChange()

setDecodingPropertyChange

public void setDecodingPropertyChange(boolean decodingPropertyChange)

decodeCSV

public java.lang.Object decodeCSV(java.lang.String fileName)

decode

public java.lang.Object decode(java.lang.String yaml,
                               java.lang.Object root)

decode

public java.lang.Object decode(java.lang.String yaml)

putNameObject

@Deprecated
public YamlIdMap putNameObject(java.lang.String id,
                                           java.lang.Object object)

Deprecated. since 1.2; use IdMap.putObject(String, Object) and IdMap.discoverObjects(Object) instead

Puts the object in this IdMap with the specified id. The call

     idMap.putNameObject("foo", bar);
 

is equivalent to

     idMap.putObject("foo", bar);
     idMap.discoverObjects(bar);
 

and the latter should be used for clarity.

Parameters:

id - the id

object - the object

Returns:

this instance, to allow method chaining

getOrCreateKey

@Deprecated
public java.lang.String getOrCreateKey(java.lang.Object obj)

Deprecated. since 1.2; use IdMap.putObject(Object) instead

collectObjects

@Deprecated
public java.util.LinkedHashSet<java.lang.Object> collectObjects(java.lang.Object... roots)

Deprecated. since 1.2; use IdMap.discoverObjects(Object...) instead (unless the resulting set is needed)

Discovers all objects reachable from the roots and within the packages specified in the constructor.

Parameters:

roots - the root objects

Returns:

a set of all discovered objects

See Also:

IdMap.discoverObjects(Object...)

encode

public java.lang.String encode(java.lang.Object... roots)

Encodes this IdMap to a Yaml string. This method is merely a shorthand for calling IdMap.discoverObjects(Object...) and encode(). I.e.,

    String yaml = idMap.encode(foo, bar, baz);
 

is equivalent to

    idMap.discoverObjects(foo, bar, baz);
    String yaml = idMap.encode();
 

Parameters:

roots - the root objects

Returns:

this IdMap encoded as a Yaml string

encode

public java.lang.String encode()

Encodes this IdMap to a Yaml string.

Returns:

this IdMap encoded as a Yaml string

Since:

1.2

encodeAttrValue

@Deprecated
public void encodeAttrValue(java.lang.StringBuilder buf,
                                        java.lang.Object obj,
                                        java.lang.String propertyName,
                                        java.lang.Object value)

Deprecated. since 1.2; unused

getYamlChange

public java.lang.String getYamlChange()

getLastTimeStamps

@Deprecated
public java.lang.String getLastTimeStamps()

Deprecated. since 1.2; unused

getAttributeTimeStamp

public java.lang.String getAttributeTimeStamp(java.lang.String attribute)

Since:

1.2

getLastTimeStampMap

@Deprecated
public java.util.LinkedHashMap<java.lang.String,java.lang.String> getLastTimeStampMap()

Deprecated. since 1.2; unused

getLastTimeStampMap

@Deprecated
public java.util.LinkedHashMap<java.lang.String,java.lang.String> getLastTimeStampMap(java.lang.String lastTimeStamps)

Deprecated. since 1.2; unused