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 SummaryFields inherited from class org.apache.tools.ant.types.ResourceMAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZEFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructorsConstructorDescriptionDefault 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 SummaryModifier 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.Resourceas, asOptional, clone, compareTo, equals, getLastModified, getMagicNumber, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setSize, size, toLongStringMethods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, 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.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectfinalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.IterableforEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
- 
Constructor Details- 
StringResourcepublic StringResource()Default constructor.
- 
StringResourceConstruct a StringResource with the supplied value.- Parameters:
- value- the value of this StringResource.
 
- 
StringResourceConstruct a StringResource with the supplied project and value, doing property replacement against the project if non-null.- Parameters:
- project- the owning Project.
- value- the value of this StringResource.
 
 
- 
- 
Method Details- 
setNameEnforce String immutability.
- 
setValueThe value attribute is a semantically superior alias for the name attribute.- Parameters:
- s- the String's value.
 
- 
getNameSynchronize access.
- 
getValueGet the value of this StringResource, resolving to the root reference if needed.- Returns:
- the represented String.
 
- 
isExistspublic boolean isExists()The exists attribute tells whether a resource exists.
- 
addTextAdd 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
 
- 
setEncodingSet the encoding to be used for this StringResource.- Parameters:
- s- the encoding name.
 
- 
getEncodingGet the encoding used by this StringResource.- Returns:
- the encoding name.
 
- 
getSizepublic long getSize()Get the size of this Resource.
- 
hashCodepublic int hashCode()Get the hash code for this Resource.
- 
toStringGet the string. SeegetContent()
- 
getInputStreamGet an InputStream for the Resource.- Overrides:
- getInputStreamin class- Resource
- 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.
 
- 
getOutputStreamGet an OutputStream for the Resource.- Overrides:
- getOutputStreamin class- Resource
- 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.
 
- 
setRefidOverrides the super version.
- 
getContentGet the content of this StringResource. SeegetValue()- Returns:
- a String or null if there is no value.
 
- 
getRefDescription copied from class:ResourcePerform the check for circular references and return the referenced Resource.
 
-