org.dcm4che3.conf.api.generic

Interface ReflectiveConfig.ConfigTypeAdapter<T,ST>

Type Parameters:

T - Java class

ST - Serialized representation - this intermediate format is needed for merging, so only the actual config data is used.

All Known Implementing Classes:

DefaultConfigTypeAdapters.ArrayTypeAdapter, DefaultConfigTypeAdapters.AttributeFormatTypeAdapter, DefaultConfigTypeAdapters.BooleanTypeAdapter, DefaultConfigTypeAdapters.CommonAbstractTypeAdapter, DefaultConfigTypeAdapters.DeviceTypeAdapter, DefaultConfigTypeAdapters.IntegerTypeAdapter, DefaultConfigTypeAdapters.PrimitiveAbstractTypeAdapter, DefaultConfigTypeAdapters.StringTypeAdapter, MapTypeAdapter, ReflectiveAdapter, SetTypeAdapter

Enclosing class:

ReflectiveConfig

public static interface ReflectiveConfig.ConfigTypeAdapter<T,ST>

Type adapter that handles configuration read/write/serialize/deserialize for a specific java class.

Author:

Roman K

Method Summary

Methods

Modifier and Type	Method and Description
T	deserialize(ST serialized, ReflectiveConfig config, Field field) Constructs an object from its serialized form
boolean	isWritingChildren(Field field) Should indicate whether the specified field will generate a child when writing configuration
void	merge(T prev, T curr, ReflectiveConfig config, ReflectiveConfig.ConfigWriter diffwriter, Field field)
ST	read(ReflectiveConfig config, ReflectiveConfig.ConfigReader reader, Field field) Reads an attribute from configuration into its serialized form
ST	serialize(T obj, ReflectiveConfig config, Field field) Constructs a serialized representation of an object
void	write(ST serialized, ReflectiveConfig config, ReflectiveConfig.ConfigWriter writer, Field field) Writes the serialized representation to the configuration backend.

Method Detail

write

void write(ST serialized,
         ReflectiveConfig config,
         ReflectiveConfig.ConfigWriter writer,
         Field field)
           throws ConfigurationException

Writes the serialized representation to the configuration backend.

Parameters:

obj -

config - ReflectiveConfig that can be used e.g. to retrieve DicomConfiguration Can be null!

writer - ConfigWriter to use

field - Config field. Can be used to read additional annotations, check type, etc.

Throws:

ConfigurationException

serialize

ST serialize(T obj,
           ReflectiveConfig config,
           Field field)
             throws ConfigurationException

Constructs a serialized representation of an object

Parameters:

obj -

config - ReflectiveConfig that can be used e.g. to retrieve DicomConfiguration Can be null!

field - Config field. Can be used to read additional annotations, check type, etc.

Returns:

Throws:

ConfigurationException

read

ST read(ReflectiveConfig config,
      ReflectiveConfig.ConfigReader reader,
      Field field)
        throws ConfigurationException

Reads an attribute from configuration into its serialized form

Parameters:

str -

config - ReflectiveConfig that can be used e.g. to retrieve DicomConfiguration Can be null!

reader - ConfigReader to use

field - Config field. Can be used to read additional annotations, check type, etc.

Returns:

Throws:

ConfigurationException

NamingException

deserialize

T deserialize(ST serialized,
            ReflectiveConfig config,
            Field field)
              throws ConfigurationException

Constructs an object from its serialized form

Parameters:

serialized -

config - ReflectiveConfig that can be used e.g. to retrieve DicomConfiguration Can be null!

field - Config field. Can be used to read additional annotations, check type, etc.

Returns:

Throws:

ConfigurationException

merge

void merge(T prev,
         T curr,
         ReflectiveConfig config,
         ReflectiveConfig.ConfigWriter diffwriter,
         Field field)
           throws ConfigurationException

Throws:

ConfigurationException

isWritingChildren

boolean isWritingChildren(Field field)

Should indicate whether the specified field will generate a child when writing configuration

Parameters:

field -

Returns: