Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.datatype.adapter

Class Base64Adapter

java.lang.Object

gov.nist.secauto.metaschema.core.datatype.AbstractDataTypeAdapter<ByteBuffer,IBase64BinaryItem>

gov.nist.secauto.metaschema.core.datatype.adapter.Base64Adapter

All Implemented Interfaces:

IDataTypeAdapter<ByteBuffer>

public class Base64Adapter
extends AbstractDataTypeAdapter<ByteBuffer,IBase64BinaryItem>

Field Summary

Fields inherited from class gov.nist.secauto.metaschema.core.datatype.AbstractDataTypeAdapter

DEFAULT_JSON_FIELD_NAME

Method Summary

Modifier and Type	Method	Description
String	asString(Object value)	Gets the value as a string suitable for writing as text.
ByteBuffer	copy(Object obj)	Create a copy of the provided value.
Class<IBase64BinaryItem>	getItemClass()	Get the java type of the associated item.
com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes	getJsonRawType()	The JSON primative type of the data type.
List<String>	getNames()	Get the metaschema type names associated with this adapter.
IBase64BinaryItem	newItem(Object value)	Construct a new item of this type using the provided value.
ByteBuffer	parse(String value)	Parses a provided string.

Methods inherited from class gov.nist.secauto.metaschema.core.datatype.AbstractDataTypeAdapter

canHandleQName, cast, castInternal, getDefaultJsonValueKey, getJavaClass, isParsingStartElement, isUnrappedValueAllowedInXml, isXmlMixed, parse, parse, toValue, writeJsonValue, writeXmlValue, writeXmlValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nist.secauto.metaschema.core.datatype.IDataTypeAdapter

getPreferredName, isAtomic, parseAndSupply, parseAndSupply, parseAndSupply

Method Detail

getNames

public List<String> getNames()

Description copied from interface: IDataTypeAdapter

Get the metaschema type names associated with this adapter. This name must be unique with respect to all other metaschema types.

At least one name must be provided, with the first name being the most preferred name.

Returns:

the name

getJsonRawType

public com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes getJsonRawType()

Description copied from interface: IDataTypeAdapter

The JSON primative type of the data type.

Returns:

the JSON data type

parse

public ByteBuffer parse(String value)

Description copied from interface: IDataTypeAdapter

Parses a provided string. Used to parse XML attributes, simple XML character data, and JSON/YAML property values.

Parameters:

value - the string value to parse

Returns:

the parsed data as the adapter's type

copy

public ByteBuffer copy(Object obj)

Description copied from interface: IDataTypeAdapter

Create a copy of the provided value.

Parameters:

obj - the value to copy

Returns:

the copy

asString

public String asString(Object value)

Description copied from interface: IDataTypeAdapter

Gets the value as a string suitable for writing as text. This is intended for data types that have a simple string-based structure in XML and JSON, such as for XML attributes or JSON keys. An adapter for a complex data structures that consist of XML elements will throw an UnsupportedOperationException when this is called.

Specified by:

asString in interface IDataTypeAdapter<ByteBuffer>

Overrides:

asString in class AbstractDataTypeAdapter<ByteBuffer,IBase64BinaryItem>

Parameters:

value - the data to formatted as a string

Returns:

a string

getItemClass

public Class<IBase64BinaryItem> getItemClass()

Description copied from interface: IDataTypeAdapter

Get the java type of the associated item.

Specified by:

getItemClass in interface IDataTypeAdapter<ByteBuffer>

Specified by:

getItemClass in class AbstractDataTypeAdapter<ByteBuffer,IBase64BinaryItem>

Returns:

the java associated item type

newItem

public IBase64BinaryItem newItem(Object value)

Description copied from interface: IDataTypeAdapter

Construct a new item of this type using the provided value.

Specified by:

newItem in interface IDataTypeAdapter<ByteBuffer>

Specified by:

newItem in class AbstractDataTypeAdapter<ByteBuffer,IBase64BinaryItem>

Parameters:

value - the item's value

Returns:

a new item