de.larssh.utils.xml

Class TransformerOutputProperty<T>

java.lang.Object

de.larssh.utils.xml.TransformerOutputProperty<T>

Type Parameters:

T - the output property type

public class TransformerOutputProperty<T>
extends Object

Allows reading and writing output properties of Transformer in a typed way.

Constructor Summary

Constructors

Constructor and Description
TransformerOutputProperty(String name, Function<T,String> serializer, Function<String,T> deserializer) Creates a new TransformerOutputProperty instance.

Method Summary

Modifier and Type	Method and Description
static TransformerOutputProperty<Boolean>	booleanOutputProperty(String name) Creates a boolean TransformerOutputProperty.
static TransformerOutputProperty<Class<?>>	classOutputProperty(String name) Creates a class TransformerOutputProperty.
T	get(Transformer transformer) Get an output property that is in effect for the transformer.
protected Function<String,T>	getDeserializer() Output Property Deserializer
String	getName() Output Property Name
protected Function<T,String>	getSerializer() Output Property Serializer
static TransformerOutputProperty<Integer>	integerOutputProperty(String name) Creates an integer TransformerOutputProperty.
void	set(Transformer transformer, T value) Set an output property that will be in effect for the transformation.
static TransformerOutputProperty<String>	stringOutputProperty(String name) Creates a string TransformerOutputProperty.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformerOutputProperty

public TransformerOutputProperty(String name,
                                 Function<T,String> serializer,
                                 Function<String,T> deserializer)

Creates a new TransformerOutputProperty instance.

Parameters:

name - Output Property Name

serializer - Output Property Serializer

deserializer - Output Property Deserializer

Method Detail

booleanOutputProperty

public static TransformerOutputProperty<Boolean> booleanOutputProperty(String name)

Creates a boolean TransformerOutputProperty.

Value yes means true and value no means false.

Parameters:

name - the output property name

Returns:

the TransformerOutputProperty

classOutputProperty

public static TransformerOutputProperty<Class<?>> classOutputProperty(String name)

Creates a class TransformerOutputProperty.

Parameters:

name - the output property name

Returns:

the TransformerOutputProperty

integerOutputProperty

public static TransformerOutputProperty<Integer> integerOutputProperty(String name)

Creates an integer TransformerOutputProperty.

Parameters:

name - the output property name

Returns:

the TransformerOutputProperty

stringOutputProperty

public static TransformerOutputProperty<String> stringOutputProperty(String name)

Creates a string TransformerOutputProperty.

Parameters:

name - the output property name

Returns:

the TransformerOutputProperty

get

public T get(Transformer transformer)

Get an output property that is in effect for the transformer.

If a property has been set using Transformer.setOutputProperty(String, String), that value will be returned. Otherwise, if a property is explicitly specified in the stylesheet, that value will be returned. If the value of the property has been defaulted, that is, if no value has been set explicitly either with Transformer.setOutputProperty(String, String) or in the stylesheet, the result may vary depending on implementation and input stylesheet.

Parameters:

transformer - the transformer

Returns:

the string value of the output property, or null if no property was found

Throws:

IllegalArgumentException - if the property is not supported

See Also:

TransformerOutputProperties

set

public void set(Transformer transformer,
                T value)

Set an output property that will be in effect for the transformation.

Pass a qualified property name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name. If the name has a null URL, the String only contain the local name. An application can safely check for a non-null URI by testing to see if the first character of the name is a '{' character.

For example, if a URI and local name were obtained from an element defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>, then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that no prefix is used.

The Properties object that was passed to Transformer.setOutputProperties(java.util.Properties) won't be effected by calling this method.

Parameters:

transformer - the transformer

value - The non-null string value of the output property.

Throws:

IllegalArgumentException - if the property is not supported, and is not qualified with a namespace

See Also:

TransformerOutputProperties

getName

public String getName()

Output Property Name

Returns:

the output property name

getSerializer

protected Function<T,String> getSerializer()

Output Property Serializer

Returns:

the output property serializer

getDeserializer

protected Function<String,T> getDeserializer()

Output Property Deserializer

Returns:

the output property deserializer