Class FileText
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.FileText
-
public final class FileText extends Object
Represents the text contents of a file of arbitrary plain text type.This class will be passed to instances of class FileSetCheck by Checker.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
get(int lineNo)
Retrieves a line of the text by its number.Charset
getCharset()
Get the character set which was used to read the file.File
getFile()
Get the name of the file.CharSequence
getFullText()
Retrieve the full text of the file.LineColumn
lineColumn(int pos)
Determine line and column numbers in full text.int
size()
Counts the lines of the text.String[]
toLinesArray()
Returns an array of all lines.
-
-
-
Constructor Detail
-
FileText
public FileText(File file, String charsetName) throws IOException
Creates a new file text representation.The file will be read using the specified encoding, replacing malformed input and unmappable characters with the default replacement character.
- Parameters:
file
- the name of the filecharsetName
- the encoding to use when reading the file- Throws:
NullPointerException
- if the text is nullIOException
- if the file could not be read
-
FileText
public FileText(FileText fileText)
Copy constructor.- Parameters:
fileText
- to make copy of
-
FileText
public FileText(File file, List<String> lines)
Compatibility constructor.This constructor reconstructs the text of the file by joining lines with linefeed characters. This process does not restore the original line terminators and should therefore be avoided.
- Parameters:
file
- the name of the filelines
- the lines of the text, without terminators- Throws:
NullPointerException
- if the lines array is null
-
-
Method Detail
-
getFile
public File getFile()
Get the name of the file.- Returns:
- an object containing the name of the file
-
getCharset
public Charset getCharset()
Get the character set which was used to read the file. Will benull
for a file reconstructed from its lines.- Returns:
- the charset used when the file was read
-
getFullText
public CharSequence getFullText()
Retrieve the full text of the file.- Returns:
- the full text of the file
-
toLinesArray
public String[] toLinesArray()
Returns an array of all lines.text.toLinesArray()
is equivalent totext.toArray(new String[text.size()])
.- Returns:
- an array of all lines of the text
-
lineColumn
public LineColumn lineColumn(int pos)
Determine line and column numbers in full text.- Parameters:
pos
- the character position in the full text- Returns:
- the line and column numbers of this character
-
get
public String get(int lineNo)
Retrieves a line of the text by its number. The returned line will not contain a trailing terminator.- Parameters:
lineNo
- the number of the line to get, starting at zero- Returns:
- the line with the given number
-
size
public int size()
Counts the lines of the text.- Returns:
- the number of lines in the text
-
-