Class StringResource
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Resource
org.apache.tools.ant.types.resources.StringResource
- All Implemented Interfaces:
Cloneable,Comparable<Resource>,Iterable<Resource>,ResourceCollection
Exposes a string as a Resource.
- Since:
- Ant 1.7
-
Field Summary
Fields inherited from class org.apache.tools.ant.types.Resource
MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZEFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.StringResource(String value) Construct a StringResource with the supplied value.StringResource(Project project, String value) Construct a StringResource with the supplied project and value, doing property replacement against the project if non-null. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd nested text to this resource.protected StringGet the content of this StringResource.Get the encoding used by this StringResource.Get an InputStream for the Resource.getName()Synchronize access.Get an OutputStream for the Resource.protected StringResourcegetRef()Perform the check for circular references and return the referenced Resource.longgetSize()Get the size of this Resource.getValue()Get the value of this StringResource, resolving to the root reference if needed.inthashCode()Get the hash code for this Resource.booleanisExists()The exists attribute tells whether a resource exists.voidSet the encoding to be used for this StringResource.voidEnforce String immutability.voidOverrides the super version.voidThe value attribute is a semantically superior alias for the name attribute.toString()Get the string.Methods inherited from class org.apache.tools.ant.types.Resource
as, asOptional, clone, compareTo, equals, getLastModified, getMagicNumber, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setSize, size, toLongStringMethods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollection
isEmpty, stream
-
Constructor Details
-
StringResource
public StringResource()Default constructor. -
StringResource
Construct a StringResource with the supplied value.- Parameters:
value- the value of this StringResource.
-
StringResource
-
-
Method Details
-
setName
-
setValue
The value attribute is a semantically superior alias for the name attribute.- Parameters:
s- the String's value.
-
getName
-
getValue
Get the value of this StringResource, resolving to the root reference if needed.- Returns:
- the represented String.
-
isExists
-
addText
Add nested text to this resource. Properties will be expanded during this process.- Parameters:
text- text to use as the string resource- Since:
- Ant 1.7.1
-
setEncoding
Set the encoding to be used for this StringResource.- Parameters:
s- the encoding name.
-
getEncoding
Get the encoding used by this StringResource.- Returns:
- the encoding name.
-
getSize
-
hashCode
-
toString
Get the string. SeegetContent() -
getInputStream
Get an InputStream for the Resource.- Overrides:
getInputStreamin classResource- Returns:
- an InputStream containing this Resource's content.
- Throws:
IOException- if unable to provide the content of this Resource as a stream.UnsupportedOperationException- if InputStreams are not supported for this Resource type.
-
getOutputStream
Get an OutputStream for the Resource.- Overrides:
getOutputStreamin classResource- Returns:
- an OutputStream to which content can be written.
- Throws:
IOException- if unable to provide the content of this Resource as a stream.UnsupportedOperationException- if OutputStreams are not supported for this Resource type.
-
setRefid
-
getContent
Get the content of this StringResource. SeegetValue()- Returns:
- a String or null if there is no value.
-
getRef
Description copied from class:ResourcePerform the check for circular references and return the referenced Resource.
-