Top Description Inners Fields Constructors Methods
org.apache.tools.ant.taskdefs

public Class Concat

extends Task
implements ResourceCollection
Class Inheritance
All Implemented Interfaces
org.apache.tools.ant.types.ResourceCollection, java.lang.Iterable
Imports
java.io.BufferedReader, .File, .FileReader, .IOException, .InputStream, .InputStreamReader, .Reader, .StringReader, .Writer, java.nio.file.Files, java.util.Arrays, .Collections, .Iterator, .Vector, org.apache.tools.ant.BuildException, .Project, .ProjectComponent, .Task, org.apache.tools.ant.filters.util.ChainReaderHelper, org.apache.tools.ant.types.FileList, .FileSet, .FilterChain, .Path, .Resource, .ResourceCollection, org.apache.tools.ant.types.resources.FileResource, .Intersect, .LogOutputResource, .Resources, .Restrict, .StringResource, org.apache.tools.ant.types.resources.selectors.Exists, .Not, .ResourceSelector, org.apache.tools.ant.types.selectors.SelectorUtils, org.apache.tools.ant.util.ConcatResourceInputStream, .FileUtils, .ReaderInputStream, .ResourceUtils

This class contains the 'concat' task, used to concatenate a series of files into a single stream. The destination of this stream may be the system console, or a file. The following is a sample invocation:
<concat destfile="${build.dir}/index.xml"
  append="false">

  <fileset dir="${xml.root.dir}"
    includes="*.xml" />

</concat>

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
private class
Concat.LastLineFixingReader

This class reads a Reader and ensures it ends with the desired linebreak

private class
Concat.MultiReader<S>

This class reads from each of the source files in turn.

private static interface
public static class
Concat.TextElement

sub element points to a file or contains text

Field Summary

Modifier and TypeField and Description
private boolean
append

Whether or not the stream should be appended if the destination file exists.

private boolean
binary

Stores the binary attribute

private static final int
private Resource
dest

The destination of the stream.

private String
encoding

Stores the input file encoding.

private String
eolString

endofline for fixlast line

private static final ResourceSelector
private static final FileUtils
private boolean
filterBeforeConcat

Stores the filterBeforeConcat attribute

private Vector<FilterChain>
filterChains

for filtering the concatenated

private boolean
fixLastLine

add missing line.separator to files

private Concat.TextElement
footer

String to place at the start of the concatenated stream

private boolean
force

overwrite read-only files

private boolean
forceOverwrite

ignore dates on input files

private Concat.TextElement
header

String to place at the end of the concatenated stream

private Concat.ReaderFactory<Reader>
private boolean
ignoreEmpty

whether to not create dest if no source files are available

private static final ResourceSelector
private String
outputEncoding

Stores the output file encoding.

private Writer
outputWriter

outputwriter

private Resources
rc

Stores a collection of file sets and/or file lists, used to select multiple files for concatenation.

private String
resourceName

exposed resource name

private Concat.ReaderFactory<Resource>
private StringBuffer
textBuffer

This buffer stores the text within the 'concat' element.

Inherited from org.apache.tools.ant.Task:
targettaskNametaskTypewrapper

Constructor Summary

AccessConstructor and Description
public
Concat()

Construct a new Concat task.

Method Summary

Modifier and TypeMethod and Description
public void
add(ResourceCollection
the ResourceCollection to add.
c
)

Add an arbitrary ResourceCollection.

public void
addFilelist(FileList
the list of files
list
)

List of files to concatenate.

public void
addFileset(FileSet
the set of files
set
)

Set of files to concatenate.

public void
addFilterChain(FilterChain
a filterchain to filter the concatenated input
filterChain
)

Adds a FilterChain.

public void
addFooter(Concat.TextElement
the footer
footerToAdd
)

Add a footer to the concatenated output

public void
addHeader(Concat.TextElement
the header
headerToAdd
)

Add a header to the concatenated output

public void
addText(String
the text to be concatenated.
text
)

This method adds text which appears in the 'concat' element.

public Path

Returns:

the path used for concatenating
createPath
()

Path of files to concatenate.

public void
execute()

Overrides org.apache.tools.ant.Task.execute.

Execute the concat task.
private Reader
private ResourceCollection
getResources()

Get the resources to concatenate.

public boolean

Returns:

false.
isFilesystemOnly
()

Implements org.apache.tools.ant.types.ResourceCollection.isFilesystemOnly.

Implement ResourceCollection.
private boolean
public Iterator<Resource>

Returns:

Iterator<Resource>.
iterator
()

Implements java.lang.Iterable.iterator.

Implement ResourceCollection.
public void
reset()

Reset state to default.

private void
sanitizeText()

Treat empty nested text as no text.

public void
setAppend(boolean
if true append output.
append
)

Sets the behavior when the destination exists.

public void
setBinary(boolean
if true, enable binary mode.
binary
)

Set the binary attribute.

public void
setDest(Resource
the Resource to write to.
dest
)

Set the resource to write to.

public void
setDestfile(File
the destination file
destinationFile
)

Sets the destination file, or uses the console if not specified.

public void
setEncoding(String
the encoding of the input stream and unless outputencoding is set, the outputstream.
encoding
)

Sets the character encoding

public void
setEol(FixCRLF.CrLf
the type of new line to add - cr, mac, lf, unix, crlf, or dos
crlf
)

Specify the end of line to find and to add if not present at end of each input file.

public void
setFilterBeforeConcat(final boolean
if true, filter each input before concatenation
filterBeforeConcat
)

Set the filterBeforeConcat attribute.

public void
setFixLastLine(boolean
if true make sure each input file has new line on the concatenated stream
fixLastLine
)

Append line.separator to files that do not end with a line.separator, default false.

public void
setForce(boolean
if true always overwrite, otherwise only overwrite if the output file is older any of the input files.
forceOverwrite
)

Deprecated use #setOverwrite instead
Force overwrite existing destination file
public void
setForceReadOnly(boolean
boolean
f
)

Whether read-only destinations will be overwritten.

public void
setIgnoreEmpty(boolean
if false, honour destination file creation.
ignoreEmpty
)

Sets the behavior when no source resource files are available.

public void
setOutputEncoding(String
the encoding for the output file
outputEncoding
)

Sets the character encoding for outputting

public void
setOverwrite(boolean
if true always overwrite, otherwise only overwrite if the output file is older any of the input files.
forceOverwrite
)

Force overwrite existing destination file

public void
setResourceName(String
to set
resourceName
)

Set the name that will be reported by the exposed Resource.

public void
setWriter(Writer
the output writer.
outputWriter
)

Set the output writer.

public int

Returns:

1.
size
()

Implements org.apache.tools.ant.types.ResourceCollection.size.

Implement ResourceCollection.
private void
validate()

Validate configuration options.

Inherited from org.apache.tools.ant.Task:
bindToOwnergetOwningTargetgetRuntimeConfigurableWrappergetTaskNamegetTaskTypegetWrapperhandleErrorFlushhandleErrorOutputhandleFlushhandleInputhandleOutputinitisInvalidloglogloglogmaybeConfigureperformreconfiguresetOwningTargetsetRuntimeConfigurableWrappersetTaskNamesetTaskType

Field Detail

appendback to summary
private boolean append

Whether or not the stream should be appended if the destination file exists. Defaults to false.

binaryback to summary
private boolean binary

Stores the binary attribute

BUFFER_SIZEback to summary
private static final int BUFFER_SIZE
destback to summary
private Resource dest

The destination of the stream. If null, the system console is used.

encodingback to summary
private String encoding

Stores the input file encoding.

eolStringback to summary
private String eolString

endofline for fixlast line

EXISTSback to summary
private static final ResourceSelector EXISTS
FILE_UTILSback to summary
private static final FileUtils FILE_UTILS
filterBeforeConcatback to summary
private boolean filterBeforeConcat

Stores the filterBeforeConcat attribute

filterChainsback to summary
private Vector<FilterChain> filterChains

for filtering the concatenated

fixLastLineback to summary
private boolean fixLastLine

add missing line.separator to files

forceback to summary
private boolean force

overwrite read-only files

forceOverwriteback to summary
private boolean forceOverwrite

ignore dates on input files

identityReaderFactoryback to summary
private Concat.ReaderFactory<Reader> identityReaderFactory
ignoreEmptyback to summary
private boolean ignoreEmpty

whether to not create dest if no source files are available

NOT_EXISTSback to summary
private static final ResourceSelector NOT_EXISTS
outputEncodingback to summary
private String outputEncoding

Stores the output file encoding.

outputWriterback to summary
private Writer outputWriter

outputwriter

rcback to summary
private Resources rc

Stores a collection of file sets and/or file lists, used to select multiple files for concatenation.

resourceNameback to summary
private String resourceName

exposed resource name

resourceReaderFactoryback to summary
private Concat.ReaderFactory<Resource> resourceReaderFactory
textBufferback to summary
private StringBuffer textBuffer

This buffer stores the text within the 'concat' element.

Constructor Detail

Concatback to summary
public Concat()

Construct a new Concat task.

Method Detail

addback to summary
public void add(ResourceCollection c)

Add an arbitrary ResourceCollection.

Parameters
c:ResourceCollection

the ResourceCollection to add.

Since
Ant 1.7
addFilelistback to summary
public void addFilelist(FileList list)

List of files to concatenate.

Parameters
list:FileList

the list of files

addFilesetback to summary
public void addFileset(FileSet set)

Set of files to concatenate.

Parameters
set:FileSet

the set of files

addFilterChainback to summary
public void addFilterChain(FilterChain filterChain)

Adds a FilterChain.

Parameters
filterChain:FilterChain

a filterchain to filter the concatenated input

Since
Ant 1.6
addFooterback to summary
public void addFooter(Concat.TextElement footerToAdd)

Add a footer to the concatenated output

Parameters
footerToAdd:Concat.TextElement

the footer

Since
Ant 1.6
addHeaderback to summary
public void addHeader(Concat.TextElement headerToAdd)

Add a header to the concatenated output

Parameters
headerToAdd:Concat.TextElement

the header

Since
Ant 1.6
addTextback to summary
public void addText(String text)

This method adds text which appears in the 'concat' element.

Parameters
text:String

the text to be concatenated.

createPathback to summary
public Path createPath()

Path of files to concatenate.

Returns:Path

the path used for concatenating

Since
Ant 1.6
executeback to summary
public void execute()

Overrides org.apache.tools.ant.Task.execute.

Execute the concat task.

Annotations
@Override
getFilteredReaderback to summary
private Reader getFilteredReader(Reader r)
getResourcesback to summary
private ResourceCollection getResources()

Get the resources to concatenate.

isFilesystemOnlyback to summary
public boolean isFilesystemOnly()

Implements org.apache.tools.ant.types.ResourceCollection.isFilesystemOnly.

Implement ResourceCollection.

Returns:boolean

false.

Annotations
@Override
isUpToDateback to summary
private boolean isUpToDate(ResourceCollection c)
iteratorback to summary
public Iterator<Resource> iterator()

Implements java.lang.Iterable.iterator.

Implement ResourceCollection.

Returns:Iterator<Resource>

Iterator<Resource>.

Annotations
@Override
resetback to summary
public void reset()

Reset state to default.

sanitizeTextback to summary
private void sanitizeText()

Treat empty nested text as no text.

Depending on the XML parser, addText may have been called for "ignorable whitespace" as well.

setAppendback to summary
public void setAppend(boolean append)

Sets the behavior when the destination exists. If set to true the task will append the stream data an Appendable resource; otherwise existing content will be overwritten. Defaults to false.

Parameters
append:boolean

if true append output.

setBinaryback to summary
public void setBinary(boolean binary)

Set the binary attribute. If true, concat will concatenate the files byte for byte. This mode does not allow any filtering or other modifications to the input streams. The default value is false.

Parameters
binary:boolean

if true, enable binary mode.

Since
Ant 1.6.2
setDestback to summary
public void setDest(Resource dest)

Set the resource to write to.

Parameters
dest:Resource

the Resource to write to.

Since
Ant 1.8
setDestfileback to summary
public void setDestfile(File destinationFile)

Sets the destination file, or uses the console if not specified.

Parameters
destinationFile:File

the destination file

setEncodingback to summary
public void setEncoding(String encoding)

Sets the character encoding

Parameters
encoding:String

the encoding of the input stream and unless outputencoding is set, the outputstream.

setEolback to summary
public void setEol(FixCRLF.CrLf crlf)

Specify the end of line to find and to add if not present at end of each input file. This attribute is used in conjunction with fixlastline.

Parameters
crlf:FixCRLF.CrLf

the type of new line to add - cr, mac, lf, unix, crlf, or dos

Since
Ant 1.6
setFilterBeforeConcatback to summary
public void setFilterBeforeConcat(final boolean filterBeforeConcat)

Set the filterBeforeConcat attribute. If true, concat will filter each input through the filterchain before concatenating the results. This allows to e.g. use the FileTokenizer to tokenize each input.

Parameters
filterBeforeConcat:boolean

if true, filter each input before concatenation

Since
Ant 1.10.10
setFixLastLineback to summary
public void setFixLastLine(boolean fixLastLine)

Append line.separator to files that do not end with a line.separator, default false.

Parameters
fixLastLine:boolean

if true make sure each input file has new line on the concatenated stream

Since
Ant 1.6
setForceback to summary
public void setForce(boolean forceOverwrite)

Deprecated

use #setOverwrite instead

Force overwrite existing destination file

Parameters
forceOverwrite:boolean

if true always overwrite, otherwise only overwrite if the output file is older any of the input files.

Annotations
@Deprecated
Since
Ant 1.6
setForceReadOnlyback to summary
public void setForceReadOnly(boolean f)

Whether read-only destinations will be overwritten.

Defaults to false

Parameters
f:boolean

boolean

Since
Ant 1.8.2
setIgnoreEmptyback to summary
public void setIgnoreEmpty(boolean ignoreEmpty)

Sets the behavior when no source resource files are available. If set to false the destination file will always be created. Defaults to true.

Parameters
ignoreEmpty:boolean

if false, honour destination file creation.

Since
Ant 1.8.0
setOutputEncodingback to summary
public void setOutputEncoding(String outputEncoding)

Sets the character encoding for outputting

Parameters
outputEncoding:String

the encoding for the output file

Since
Ant 1.6
setOverwriteback to summary
public void setOverwrite(boolean forceOverwrite)

Force overwrite existing destination file

Parameters
forceOverwrite:boolean

if true always overwrite, otherwise only overwrite if the output file is older any of the input files.

Since
Ant 1.8.2
setResourceNameback to summary
public void setResourceName(String resourceName)

Set the name that will be reported by the exposed Resource.

Parameters
resourceName:String

to set

Since
Ant 1.8.3
setWriterback to summary
public void setWriter(Writer outputWriter)

Set the output writer. This is to allow concat to be used as a nested element.

Parameters
outputWriter:Writer

the output writer.

Since
Ant 1.6
sizeback to summary
public int size()

Implements org.apache.tools.ant.types.ResourceCollection.size.

Implement ResourceCollection.

Returns:int

1.

Annotations
@Override
validateback to summary
private void validate()

Validate configuration options.

org.apache.tools.ant.taskdefs back to summary

private final Class Concat.ConcatResource

extends Resource
Class Inheritance

Field Summary

Modifier and TypeField and Description
private ResourceCollection
c

Inherited from org.apache.tools.ant.types.Resource:
MAGICUNKNOWN_DATETIMEUNKNOWN_SIZE

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public InputStream
getInputStream()

Overrides org.apache.tools.ant.types.Resource.getInputStream.

Get an InputStream for the Resource.
public String
getName()

Overrides org.apache.tools.ant.types.Resource.getName.

Name attribute will contain the path of a file relative to the root directory of its fileset or the recorded path of a zip entry.
Inherited from org.apache.tools.ant.types.Resource:
asasOptionalclonecompareToequalsgetLastModifiedgetMagicNumbergetOutputStreamgetRefgetSizehashCodeisDirectoryisExistsisFilesystemOnlyiteratorsetDirectorysetExistssetLastModifiedsetNamesetRefidsetSizesizetoLongStringtoString

Field Detail

cback to summary
private ResourceCollection c

Constructor Detail

ConcatResourceback to summary
private ConcatResource(ResourceCollection c)

Method Detail

getInputStreamback to summary
public InputStream getInputStream()

Overrides org.apache.tools.ant.types.Resource.getInputStream.

Doc from org.apache.tools.ant.types.Resource.getInputStream.

Get an InputStream for the Resource.

Returns:InputStream

an InputStream containing this Resource's content.

Annotations
@Override
getNameback to summary
public String getName()

Overrides org.apache.tools.ant.types.Resource.getName.

Doc from org.apache.tools.ant.types.Resource.getName.

Name attribute will contain the path of a file relative to the root directory of its fileset or the recorded path of a zip entry.

example for a file with fullpath /var/opt/adm/resource.txt in a file set with root dir /var/opt it will be adm/resource.txt.

"/" will be used as the directory separator.

Returns:String

the name of this resource.

Annotations
@Override
org.apache.tools.ant.taskdefs back to summary

private final Class Concat.LastLineFixingReader

extends Reader
Class Inheritance

This class reads a Reader and ensures it ends with the desired linebreak
Since
Ant 1.10.10

Field Summary

Modifier and TypeField and Description
private final char[]
private int
private boolean
private final Reader
Inherited from java.io.Reader:
lock

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private void
addLastChar(char ch)

if checking for end of line at end of file add a character to the lastchars buffer

public void
close()

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Close the current reader
private boolean
isMissingEndOfLine()

return true if the lastchars buffer does not contain the line separator

public int

Returns:

the character read, -1 for EOF on the last reader.
read
()

Overrides java.io.Reader.read.

Read a character from the current reader object.
public int
read(char[]
The array to be read into.
cbuf
,
int
The offset.
off
,
int
The length to read.
len
)

Implements abstract java.io.Reader.read.

Read into the buffer cbuf.
Inherited from java.io.Reader:
markmarkSupportednullReaderreadreadreadyresetskiptransferTo

Field Detail

lastCharsback to summary
private final char[] lastChars
lastPosback to summary
private int lastPos
needAddSeparatorback to summary
private boolean needAddSeparator
readerback to summary
private final Reader reader

Constructor Detail

LastLineFixingReaderback to summary
private LastLineFixingReader(Reader reader)

Method Detail

addLastCharback to summary
private void addLastChar(char ch)

if checking for end of line at end of file add a character to the lastchars buffer

closeback to summary
public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Close the current reader

Annotations
@Override
Exceptions
IOException:

Doc from java.io.Reader.close.

If an I/O error occurs

isMissingEndOfLineback to summary
private boolean isMissingEndOfLine()

return true if the lastchars buffer does not contain the line separator

readback to summary
public int read() throws IOException

Overrides java.io.Reader.read.

Read a character from the current reader object. Advance to the next if the reader is finished.

Returns:int

the character read, -1 for EOF on the last reader.

Annotations
@Override
Exceptions
IOException:
- possibly thrown by the read for a reader object.
readback to summary
public int read(char[] cbuf, int off, int len) throws IOException

Implements abstract java.io.Reader.read.

Read into the buffer cbuf.

Parameters
cbuf:char[]

The array to be read into.

off:int

The offset.

len:int

The length to read.

Returns:int

Doc from java.io.Reader.read.

The number of characters read, or -1 if the end of the stream has been reached

Annotations
@Override
Exceptions
IOException:
- possibly thrown by the reads to the reader objects.
org.apache.tools.ant.taskdefs back to summary

private final Class Concat.MultiReader<S>

extends Reader
Class Inheritance

This class reads from each of the source files in turn. The concatenated result can then be filtered as a single stream.

Field Summary

Modifier and TypeField and Description
private Concat.ReaderFactory<S>
private final boolean
private Reader
private Iterator<S>
Inherited from java.io.Reader:
lock

Constructor Summary

AccessConstructor and Description
private
MultiReader(Iterator<S> readerSources, Concat.ReaderFactory<S> factory, boolean filterBeforeConcat)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Close the current reader
private Reader
private boolean
private void
public int

Returns:

the character read, -1 for EOF on the last reader.
read
()

Overrides java.io.Reader.read.

Read a character from the current reader object.
public int
read(char[]
The array to be read into.
cbuf
,
int
The offset.
off
,
int
The length to read.
len
)

Implements abstract java.io.Reader.read.

Read into the buffer cbuf.
Inherited from java.io.Reader:
markmarkSupportednullReaderreadreadreadyresetskiptransferTo

Field Detail

factoryback to summary
private Concat.ReaderFactory<S> factory
filterBeforeConcatback to summary
private final boolean filterBeforeConcat
readerback to summary
private Reader reader
readerSourcesback to summary
private Iterator<S> readerSources

Constructor Detail

MultiReaderback to summary
private MultiReader(Iterator<S> readerSources, Concat.ReaderFactory<S> factory, boolean filterBeforeConcat)

Method Detail

closeback to summary
public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Close the current reader

Annotations
@Override
Exceptions
IOException:

Doc from java.io.Reader.close.

If an I/O error occurs

getReaderback to summary
private Reader getReader() throws IOException
isFixLastLineback to summary
private boolean isFixLastLine()
nextReaderback to summary
private void nextReader() throws IOException
readback to summary
public int read() throws IOException

Overrides java.io.Reader.read.

Read a character from the current reader object. Advance to the next if the reader is finished.

Returns:int

the character read, -1 for EOF on the last reader.

Annotations
@Override
Exceptions
IOException:
- possibly thrown by the read for a reader object.
readback to summary
public int read(char[] cbuf, int off, int len) throws IOException

Implements abstract java.io.Reader.read.

Read into the buffer cbuf.

Parameters
cbuf:char[]

The array to be read into.

off:int

The offset.

len:int

The length to read.

Returns:int

Doc from java.io.Reader.read.

The number of characters read, or -1 if the end of the stream has been reached

Annotations
@Override
Exceptions
IOException:
- possibly thrown by the reads to the reader objects.
org.apache.tools.ant.taskdefs back to summary

private Interface Concat.ReaderFactory<S>


Method Summary

Modifier and TypeMethod and Description
public Reader
getReader(S s)

Method Detail

getReaderback to summary
public Reader getReader(S s) throws IOException
org.apache.tools.ant.taskdefs back to summary

public Class Concat.TextElement

extends ProjectComponent
Class Inheritance

sub element points to a file or contains text

Field Summary

Modifier and TypeField and Description
private String
private boolean
private boolean
private boolean
private String
Inherited from org.apache.tools.ant.ProjectComponent:
descriptionlocationproject

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
addText(String
the text to place inline
value
)

set the text using inline

private boolean
getFiltering()

return the filtering attribute

public String

Returns:

the text, after possible trimming
getValue
()

public void
setEncoding(String
the name of the charset used to encode
encoding
)

The encoding of the text element

public void
setFile(File
the file to use
file
)

set the text using a file

public void
setFiltering(boolean
true if the text should be filtered. the default value is true.
filtering
)

whether to filter the text in this element or not.

public void
setTrim(boolean
if true trim the text
trim
)

whether to call text.trim()

public void
setTrimLeading(boolean
if true do the trim
strip
)

s:^\s*:: on each line of input

Inherited from org.apache.tools.ant.ProjectComponent:
clonegetDescriptiongetLocationgetProjectloglogsetDescriptionsetLocationsetProject

Field Detail

encodingback to summary
private String encoding
filteringback to summary
private boolean filtering
trimback to summary
private boolean trim
trimLeadingback to summary
private boolean trimLeading
valueback to summary
private String value

Constructor Detail

TextElementback to summary
public TextElement()

Method Detail

addTextback to summary
public void addText(String value)

set the text using inline

Parameters
value:String

the text to place inline

getFilteringback to summary
private boolean getFiltering()

return the filtering attribute

getValueback to summary
public String getValue()
Returns:String

the text, after possible trimming

setEncodingback to summary
public void setEncoding(String encoding)

The encoding of the text element

Parameters
encoding:String

the name of the charset used to encode

setFileback to summary
public void setFile(File file) throws BuildException

set the text using a file

Parameters
file:File

the file to use

Exceptions
BuildException:
if the file does not exist, or cannot be read
setFilteringback to summary
public void setFiltering(boolean filtering)

whether to filter the text in this element or not.

Parameters
filtering:boolean

true if the text should be filtered. the default value is true.

setTrimback to summary
public void setTrim(boolean trim)

whether to call text.trim()

Parameters
trim:boolean

if true trim the text

setTrimLeadingback to summary
public void setTrimLeading(boolean strip)

s:^\s*:: on each line of input

Parameters
strip:boolean

if true do the trim