org.jomc.ant.types
Class ResourceType

Package class diagram package ResourceType
java.lang.Object
  extended by org.jomc.ant.types.ResourceType
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
ModletResourceType, ModuleResourceType, PropertiesResourceType, TransformerResourceType

public class ResourceType
extends Object
implements Cloneable

Datatype describing a resource.

Version:
$JOMC: ResourceType.java 3838 2011-10-08 20:15:41Z schulte2005 $
Author:
Christian Schulte

Constructor Summary
ResourceType()
          Creates a new ResourceType instance.
 
Method Summary
 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.
See Also:
setLocation(java.lang.String)

setLocation

public final void setLocation(String value)
Sets the value of the location property.

Parameters:
value - The value of the location property.
See Also:
getLocation()

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.
See Also:
setOptional(boolean)

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.
See Also:
isOptional()

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.
See Also:
setConnectTimeout(int)

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.
See Also:
getConnectTimeout()

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.
See Also:
setReadTimeout(int)

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.
See Also:
getReadTimeout()

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.


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.