org.jomc.mojo

Class PropertiesResourceType

java.lang.Object

org.jomc.mojo.ResourceType

org.jomc.mojo.PropertiesResourceType

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

TemplateParameterResource, TransformationParameterResource, VelocityPropertyResource

public class PropertiesResourceType
extends ResourceType

Datatype describing a properties resource.

Since:

1.2

Version:

$JOMC: PropertiesResourceType.java 5135 2016-04-08 13:53:07Z schulte $

Author:

Christian Schulte

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLAIN_FORMAT Constant for the plain properties file format.
static String	XML_FORMAT Constant for the XML properties file format.

Constructor Summary

Constructors

Constructor and Description
PropertiesResourceType() Creates a new PropertiesResourceType instance.

Method Summary

Methods

Modifier and Type	Method and Description
PropertiesResourceType	clone() Creates and returns a copy of this object.
String	getFormat() Gets the value of the format property.
static List<String>	getSupportedFormats() Gets a list holding supported format values.
static boolean	isFormatSupported(String value) Tests a given format value.
void	setFormat(String value) Sets the value of the format property.

Methods inherited from class org.jomc.mojo.ResourceType

getConnectTimeout, getLocation, getReadTimeout, isOptional, setConnectTimeout, setLocation, setOptional, setReadTimeout, toString

Methods inherited from class java.lang.Object

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

Field Detail

PLAIN_FORMAT

public static final String PLAIN_FORMAT

Constant for the plain properties file format.

See Also:

Constant Field Values

XML_FORMAT

public static final String XML_FORMAT

Constant for the XML properties file format.

See Also:

Constant Field Values

Constructor Detail

PropertiesResourceType

public PropertiesResourceType()

Creates a new PropertiesResourceType instance.

Method Detail

getFormat

public final String getFormat()

Gets the value of the format property.

Returns:

The value of the format property.

setFormat

public final void setFormat(String value)

Sets the value of the format property.

Parameters:

value - The new value of the format property or null.

getSupportedFormats

public static List<String> getSupportedFormats()

Gets a list holding supported format values.

Returns:

An unmodifiable list holding supported format values.

See Also:

isFormatSupported(java.lang.String)

isFormatSupported

public static boolean isFormatSupported(String value)

Tests a given format value.

Parameters:

value - The format value to test.

Returns:

true, if the given format value is supported; false, if the given format value is not supported.

See Also:

getSupportedFormats()

clone

public PropertiesResourceType clone()

Creates and returns a copy of this object.

Overrides:

clone in class ResourceType

Returns:

A copy of this object.