org.apache.tools.ant.filters
Class FixCrLfFilter
- ChainableReader, Parameterizable
public final class FixCrLfFilter
Converts text to local OS formatting conventions, as well as repair text
damaged by misconfigured or misguided editors or file transfer programs.
This filter can take the following arguments:
- eof
- eol
- fixlast
- javafiles
- tab
- tablength
None of which are required.
This version generalises the handling of EOL characters, and allows for
CR-only line endings (the standard on Mac systems prior to OS X). Tab
handling has also been generalised to accommodate any tabwidth from 2 to 80,
inclusive. Importantly, it can leave untouched any literal TAB characters
embedded within Java string or character constants.
Caution: run with care on carefully formatted files. This may
sound obvious, but if you don't specify asis, presume that your files are
going to be modified. If "tabs" is "add" or "remove", whitespace characters
may be added or removed as necessary. Similarly, for EOLs, eol="asis"
actually means convert to your native O/S EOL convention while eol="crlf" or
cr="add" can result in CR characters being removed in one special case
accommodated, i.e., CRCRLF is regarded as a single EOL to handle cases where
other programs have converted CRLF into CRCRLF.
Example:
<<fixcrlf tab="add" eol="crlf" eof="asis"/>
Or:
<filterreader classname="org.apache.tools.ant.filters.FixCrLfFilter">
<param eol="crlf" tab="asis"/>
</filterreader>
FixCrLfFilter
public FixCrLfFilter()
Constructor for "dummy" instances.
FixCrLfFilter
public FixCrLfFilter(Reader in)
throws IOException
Create a new filtered reader.
in
- A Reader object providing the underlying stream. Must not be
null
.
chain
public Reader chain(Reader rdr)
Create a new FixCrLfFilter using the passed in Reader for instantiation.
- chain in interface ChainableReader
rdr
- A Reader object providing the underlying stream. Must not be
null
.
- a new filter based on this configuration, but filtering the
specified reader.
getEof
public FixCrLfFilter.AddAsisRemove getEof()
Get how DOS EOF (control-z) characters are being handled.
- values:
- add: ensure that there is an eof at the end of the file
- asis: leave eof characters alone
- remove: remove any eof character found at the end
getEol
public FixCrLfFilter.CrLf getEol()
Get how EndOfLine characters are being handled.
- values:
- asis: convert line endings to your O/S convention
- cr: convert line endings to CR
- lf: convert line endings to LF
- crlf: convert line endings to CRLF
getFixlast
public boolean getFixlast()
Get whether a missing EOL be added to the final line of the stream.
- true if a filtered file will always end with an EOL
getJavafiles
public boolean getJavafiles()
Get whether the stream is to be treated as though it contains Java
source.
This attribute is only used in assocation with the "
tab"
attribute. Tabs found in Java literals are protected from changes by this
filter.
- true if whitespace in Java character and string literals is
ignored.
getTab
public FixCrLfFilter.AddAsisRemove getTab()
Return how tab characters are being handled.
- values:
- add: convert sequences of spaces which span a tab stop to
tabs
- asis: leave tab and space characters alone
- remove: convert tabs to spaces
getTablength
public int getTablength()
Get the tab length to use.
- the length of tab in spaces
read
public int read()
throws IOException
Return the next character in the filtered stream.
- the next character in the resulting stream, or -1 if the end of
the resulting stream has been reached.
setEof
public void setEof(FixCrLfFilter.AddAsisRemove attr)
Specify how DOS EOF (control-z) characters are to be handled.
attr
- valid values:
- add: ensure that there is an eof at the end of the file
- asis: leave eof characters alone
- remove: remove any eof character found at the end
setEol
public void setEol(FixCrLfFilter.CrLf attr)
Specify how end of line (EOL) characters are to be handled.
attr
- valid values:
- asis: convert line endings to your O/S convention
- cr: convert line endings to CR
- lf: convert line endings to LF
- crlf: convert line endings to CRLF
setFixlast
public void setFixlast(boolean fixlast)
Specify whether a missing EOL will be added to the final line of input.
fixlast
- if true a missing EOL will be appended.
setJavafiles
public void setJavafiles(boolean javafiles)
Indicate whether this stream contains Java source.
This attribute is only used in assocation with the "tab"
attribute.
javafiles
- set to true to prevent this filter from changing tabs found in
Java literals.
setTab
public void setTab(FixCrLfFilter.AddAsisRemove attr)
Specify how tab characters are to be handled.
attr
- valid values:
- add: convert sequences of spaces which span a tab stop to
tabs
- asis: leave tab and space characters alone
- remove: convert tabs to spaces
setTablength
public void setTablength(int tabLength)
throws IOException
Specify tab length in characters.
tabLength
- specify the length of tab in spaces. Valid values are between
2 and 80 inclusive. The default for this parameter is 8.