Class FixCrLfFilter
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
,ChainableReader
,Parameterizable
This filter can take the following arguments:
- eof
- eol
- fixlast
- javafiles
- tab
- tablength
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>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Enumerated attribute with the values "asis", "add" and "remove".static class
Enumerated attribute with the values "asis", "cr", "lf" and "crlf". -
Field Summary
Fields inherited from class java.io.FilterReader
in
-
Constructor Summary
ConstructorDescriptionConstructor for "dummy" instances.FixCrLfFilter
(Reader in) Create a new filtered reader. -
Method Summary
Modifier and TypeMethodDescriptionCreate a new FixCrLfFilter using the passed in Reader for instantiation.getEof()
Get how DOS EOF (control-z) characters are being handled.getEol()
Get how EndOfLine characters are being handled.boolean
Get whether a missing EOL be added to the final line of the stream.boolean
Get whether the stream is to be treated as though it contains Java source.getTab()
Return how tab characters are being handled.int
Get the tab length to use.int
read()
Return the next character in the filtered stream.void
Specify how DOS EOF (control-z) characters are to be handled.void
setEol
(FixCrLfFilter.CrLf attr) Specify how end of line (EOL) characters are to be handled.void
setFixlast
(boolean fixlast) Specify whether a missing EOL will be added to the final line of input.void
setJavafiles
(boolean javafiles) Indicate whether this stream contains Java source.void
Specify how tab characters are to be handled.void
setTablength
(int tabLength) Specify tab length in characters.Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
getParameters, setParameters
Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
Methods inherited from class java.io.FilterReader
close, mark, markSupported, ready, reset
Methods inherited from class java.io.Reader
nullReader, read, read, transferTo
-
Constructor Details
-
FixCrLfFilter
public FixCrLfFilter()Constructor for "dummy" instances.- See Also:
-
FixCrLfFilter
Create a new filtered reader.- Parameters:
in
- A Reader object providing the underlying stream. Must not benull
.- Throws:
IOException
- on error.
-
-
Method Details
-
chain
Create a new FixCrLfFilter using the passed in Reader for instantiation.- Specified by:
chain
in interfaceChainableReader
- Parameters:
rdr
- A Reader object providing the underlying stream. Must not benull
.- Returns:
- a new filter based on this configuration, but filtering the specified reader.
-
getEof
Get how DOS EOF (control-z) characters are being handled.- Returns:
- 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
Get how EndOfLine characters are being handled.- Returns:
- 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.- Returns:
- 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 association with the "tab" attribute. Tabs found in Java literals are protected from changes by this filter.
- Returns:
- true if whitespace in Java character and string literals is ignored.
-
getTab
Return how tab characters are being handled.- Returns:
- 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.- Returns:
- the length of tab in spaces
-
read
Return the next character in the filtered stream.- Overrides:
read
in classFilterReader
- Returns:
- the next character in the resulting stream, or -1 if the end of the resulting stream has been reached.
- Throws:
IOException
- if the underlying stream throws an IOException during reading.
-
setEof
Specify how DOS EOF (control-z) characters are to be handled.- Parameters:
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
Specify how end of line (EOL) characters are to be handled.- Parameters:
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.- Parameters:
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 association with the "tab" attribute.- Parameters:
javafiles
- set to true to prevent this filter from changing tabs found in Java literals.
-
setTab
Specify how tab characters are to be handled.- Parameters:
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
Specify tab length in characters.- Parameters:
tabLength
- specify the length of tab in spaces. Valid values are between 2 and 80 inclusive. The default for this parameter is 8.- Throws:
IOException
- on error.
-