org.qas.api.internal

Class PropertyContainer

java.lang.Object

org.qas.api.internal.PropertyContainer

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AllowedValue, ClientConfiguration, DefectTrackingSystem, FieldValue, Link, QTestBaseModel, ResponseMetadata, SimpleCredentials

@JsonModel
public class PropertyContainer
extends java.lang.Object
implements java.lang.Cloneable

PropertyContainer

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	NL
protected java.util.Map<java.lang.String,java.lang.Object>	properties
protected static java.util.regex.Pattern	RESERVED_NAME

Constructor Summary

Constructors

Constructor and Description
PropertyContainer()

Method Summary

Modifier and Type	Method and Description
void	appendPropertiesTo(JsonObject jsonObject) Deprecated.
void	appendPropertiesTo(java.lang.StringBuilder builder, java.lang.String indent, int depth) Deprecated.
java.util.Date	asDate(java.lang.String key)
java.util.Date	asDate(java.lang.String key, java.util.Date defaultValue)
java.lang.Integer	asInteger(java.lang.String key)
java.lang.Integer	asInteger(java.lang.String key, java.lang.Integer defaultValue)
java.lang.Long	asLong(java.lang.String key)
java.lang.Long	asLong(java.lang.String key, java.lang.Long defaultValue)
java.lang.String	asString(java.lang.String key)
java.lang.String	asString(java.lang.String key, java.lang.String defaultValue)
protected java.lang.Object	clone()
java.lang.String	elementName() Deprecated. will be remove in future release
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Gets all of the properties belonging to this container.
java.lang.Object	getProperty(java.lang.String name) Gets the property with the specified name.
java.util.Map<java.lang.String,java.lang.Object>	getPropertyMap()
protected boolean	hasProperties() Deprecated.
boolean	hasProperty(java.lang.String name) Returns true if a property has been set.
protected boolean	isVisible(java.lang.String key)
java.lang.String	jsonElementName() Deprecated. will be remove in future release
void	removeProperty(java.lang.String name) Removes the property which the specified name.
void	setPropertiesFrom(PropertyContainer src) A convenience method that populates properties from those in the given container.
void	setProperty(java.lang.String name, java.lang.Object value) Sets the property named, name, to value
JsonObject	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_NAME

protected static final java.util.regex.Pattern RESERVED_NAME

NL

protected static final java.lang.String NL

properties

protected final java.util.Map<java.lang.String,java.lang.Object> properties

Constructor Detail

PropertyContainer

public PropertyContainer()

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String name)

Gets the property with the specified name. The value returned may not be the same type as originally set via setProperty(String, Object)

Parameters:

name - the property name.

Returns:

the property corresponding to name

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Gets all of the properties belonging to this container.

Returns:

an unmodifiable Map of properties.

hasProperty

public boolean hasProperty(java.lang.String name)

Returns true if a property has been set. This function can be used to test if property has been specifically set to null.

Parameters:

name - the given property name.

Returns:

true iff the property named name exists.

removeProperty

public void removeProperty(java.lang.String name)

Removes the property which the specified name. If the is no property with this name set, simply does nothing.

Parameters:

name - the given property name.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Sets the property named, name, to value

Parameters:

name - the given property name.

value - the given property value.

setPropertiesFrom

public void setPropertiesFrom(PropertyContainer src)

A convenience method that populates properties from those in the given container.

Parameters:

src - the container from which we will populate ourself.

clone

protected java.lang.Object clone()

Overrides:

clone in class java.lang.Object

Returns:

the current property map.

hasProperties

@Deprecated
protected boolean hasProperties()

Deprecated.

Returns:

true if this container contains another properties except reversed name.

isVisible

protected boolean isVisible(java.lang.String key)

Parameters:

key - property key

Returns:

if the given the key is visible to display.

appendPropertiesTo

@Deprecated
public void appendPropertiesTo(java.lang.StringBuilder builder,
                                           java.lang.String indent,
                                           int depth)

Deprecated.

Build current container information and put to the given builder

Parameters:

builder - the given StringBuilder to store value.

indent - the given indent.

depth - the given depth value.

getPropertyMap

public java.util.Map<java.lang.String,java.lang.Object> getPropertyMap()

Returns:

the current property map.

elementName

@Deprecated
public java.lang.String elementName()

Deprecated. will be remove in future release

Returns:

the name of the root element.

jsonElementName

@Deprecated
public java.lang.String jsonElementName()

Deprecated. will be remove in future release

Returns:

the name of the root element.

appendPropertiesTo

@Deprecated
public void appendPropertiesTo(JsonObject jsonObject)
                                    throws JsonException

Deprecated.

Build JsonObject from the property container.

Parameters:

jsonObject - the given JsonObject to hold value.

Throws:

JsonException - if an error occurs during building json object.

toJson

public JsonObject toJson()
                  throws JsonException

Returns:

the current object as JsonObject instance.

Throws:

JsonException - if an error occurs during building json object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

asInteger

public java.lang.Integer asInteger(java.lang.String key)

Parameters:

key - property name

Returns:

0 as default value

asInteger

public java.lang.Integer asInteger(java.lang.String key,
                                   java.lang.Integer defaultValue)

Parameters:

key - property name

defaultValue - default value

Returns:

Integer value

asLong

public java.lang.Long asLong(java.lang.String key)

Parameters:

key - property name

Returns:

0L as default value

asLong

public java.lang.Long asLong(java.lang.String key,
                             java.lang.Long defaultValue)

Parameters:

key - property name

defaultValue - default value

Returns:

Long value

asString

public java.lang.String asString(java.lang.String key)

asString

public java.lang.String asString(java.lang.String key,
                                 java.lang.String defaultValue)

Parameters:

key - property name

defaultValue - default value

Returns:

String value

asDate

public java.util.Date asDate(java.lang.String key)

Parameters:

key - property name

Returns:

null as default value

asDate

public java.util.Date asDate(java.lang.String key,
                             java.util.Date defaultValue)

Parameters:

key - property name

defaultValue - default value

Returns:

Date value