com.delphix.masking.api.plugin.config

Interface GroupedProperties

All Known Implementing Classes:

GroupedPropertiesImpl

public interface GroupedProperties

Method Summary

Modifier and Type	Method and Description
static GroupedProperties	fromJson(Schema schema, com.fasterxml.jackson.databind.JsonNode json) Create an object that implements GroupedProperties from a tree of JsonNode objects
static GroupedProperties	fromJson(Schema schema, java.lang.String json) Create an object that implements GroupedProperties from a JSON string,
java.lang.Boolean	getBooleanProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.BOOLEAN in the schema.
java.lang.Double	getDoubleProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.DOUBLE in the schema.
FileReference	getFileReferenceProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.FILE in the schema.
java.lang.Long	getLongProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.LONG in the schema.
java.util.regex.Pattern	getRegexProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.REGEX in the schema.
java.util.List<GroupedProperties>	getRepeatGroup(java.lang.String groupName) Retrieve a group with type Group.Type.REPEAT in the schema.
GroupedProperties	getSimpleGroup(java.lang.String groupName) Retrieve a group with type Group.Type.SIMPLE in the schema.
java.util.List<java.lang.String>	getStringListProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.LIST in the schema.
java.util.Map<java.lang.String,java.lang.String>	getStringMapProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.MAP in the schema.
java.lang.String	getStringProp(java.lang.String propertyName) Retrieve the value of a property with type Property.Type.STRING or Property.Type.ENUM in the schema.
java.lang.String	toJson() Serialize the content of this object to a JSON String.
com.fasterxml.jackson.databind.JsonNode	toJsonNode() Convert this object into a tree of JsonNode objects.

Method Detail

fromJson

static GroupedProperties fromJson(Schema schema,
                                  java.lang.String json)
                           throws com.fasterxml.jackson.core.JsonProcessingException

Create an object that implements GroupedProperties from a JSON string,

Parameters:

schema - The schema for the GroupedProperties

json - A Json string containing the property values

Returns:

The new object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - When the JSON is invalid

java.lang.IllegalArgumentException - When the JSON is valid but does not match the provided schema

fromJson

static GroupedProperties fromJson(Schema schema,
                                  com.fasterxml.jackson.databind.JsonNode json)
                           throws com.fasterxml.jackson.core.JsonProcessingException

Create an object that implements GroupedProperties from a tree of JsonNode objects

Parameters:

schema - The schema for the GroupedProperties

json - The root node of the object tree

Returns:

The new object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - When the JSON is valid but does not match the provided schema

toJson

java.lang.String toJson()

Serialize the content of this object to a JSON String. The JSON will include any default values specified by the Schema that were not explicitly supplied in the JSON from which this object was created.

Returns:

The JSON string

toJsonNode

com.fasterxml.jackson.databind.JsonNode toJsonNode()

Convert this object into a tree of JsonNode objects.

Returns:

The root JsonNode of the resulting tree

getBooleanProp

java.lang.Boolean getBooleanProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.BOOLEAN in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional and no default is supplied in the schema

getDoubleProp

java.lang.Double getDoubleProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.DOUBLE in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional and no default is supplied in the schema

getFileReferenceProp

FileReference getFileReferenceProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.FILE in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional

getLongProp

java.lang.Long getLongProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.LONG in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional and no default is supplied in the schema

getRegexProp

java.util.regex.Pattern getRegexProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.REGEX in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional and no default is supplied in the schema

getStringProp

java.lang.String getStringProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.STRING or Property.Type.ENUM in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional and no default is supplied in the schema

getStringListProp

java.util.List<java.lang.String> getStringListProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.LIST in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional and no default is supplied in the schema

getStringMapProp

java.util.Map<java.lang.String,java.lang.String> getStringMapProp(java.lang.String propertyName)

Retrieve the value of a property with type Property.Type.MAP in the schema.

Parameters:

propertyName - The name of the property

Returns:

The property value, which may be null when the property is optional and no default is supplied in the schema

getSimpleGroup

GroupedProperties getSimpleGroup(java.lang.String groupName)

Retrieve a group with type Group.Type.SIMPLE in the schema.

Parameters:

groupName - The name of the group

Returns:

The group

getRepeatGroup

java.util.List<GroupedProperties> getRepeatGroup(java.lang.String groupName)

Retrieve a group with type Group.Type.REPEAT in the schema.

Parameters:

groupName - The name of the group

Returns:

The list of groups