org.jomc.mojo

Class ResourceType

java.lang.Object

org.jomc.mojo.ResourceType

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

PropertiesResourceType, TransformerResourceType

public class ResourceType
extends Object
implements Cloneable

Datatype describing a resource.

Since:

1.2

Version:

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

Author:

Christian Schulte

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ResourceType	clone() Creates and returns a copy of this object.
int	getConnectTimeout() Gets the timeout value, in milliseconds, to be used when opening communications links to the resource.
String	getLocation() Gets the value of the location property.
int	getReadTimeout() Gets the timeout value, in milliseconds, to be used when reading the resource.
boolean	isOptional() Gets a flag indicating the resource is optional.
void	setConnectTimeout(int value) Sets the timeout value, in milliseconds, to be used when opening communications links to the resource.
void	setLocation(String value) Sets the value of the location property.
void	setOptional(boolean value) Sets the flag indicating the resource is optional.
void	setReadTimeout(int value) Sets the timeout value, in milliseconds, to be used when reading the resource.
String	toString() Creates and returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceType

public ResourceType()

Creates a new ResourceType instance.

Method Detail

getLocation

public final String getLocation()

Gets the value of the location property.

Returns:

The value of the location property.

setLocation

public final void setLocation(String value)

Sets the value of the location property.

Parameters:

value - The value of the location property.

isOptional

public final boolean isOptional()

Gets a flag indicating the resource is optional.

Returns:

true, if the resource is optional; false, if the build fails when the resource is not found.

setOptional

public final void setOptional(boolean value)

Sets the flag indicating the resource is optional.

Parameters:

value - true, to flag the resource optional; false, to fail the build when the resource is not found.

getConnectTimeout

public final int getConnectTimeout()

Gets the timeout value, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.

Returns:

The timeout value, in milliseconds, to be used when opening communications links to the resource.

setConnectTimeout

public final void setConnectTimeout(int value)

Sets the timeout value, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.

Parameters:

value - The new timeout value, in milliseconds, to be used when opening communications links to the resource.

getReadTimeout

public final int getReadTimeout()

Gets the timeout value, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.

Returns:

The timeout value, in milliseconds, to be used when reading the resource.

setReadTimeout

public final void setReadTimeout(int value)

Sets the timeout value, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.

Parameters:

value - The new timeout value, in milliseconds, to be used when reading the resource.

clone

public ResourceType clone()

Creates and returns a copy of this object.

Overrides:

clone in class Object

Returns:

A copy of this object.

toString

public String toString()

Creates and returns a string representation of the object.

Overrides:

toString in class Object

Returns:

A string representation of the object.