com.jn.langx.text.csv

类 CsvRecord

java.lang.Object

com.jn.langx.text.csv.CsvRecord

所有已实现的接口:

Serializable, Iterable<String>

public final class CsvRecord
extends Object
implements Serializable, Iterable<String>

A CSV record parsed from a CSV file.

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static long	serialVersionUID

方法概要

限定符和类型	方法和说明
String	get(Enum<?> e) Returns a value by Enum.
String	get(int i) Returns a value by index.
String	get(String name) Returns a value by name.
long	getCharacterPosition() Returns the start position of this record as a character position in the source stream.
String	getComment() Returns the comment for this record, if any.
CsvParser	getParser() Returns the parser.
long	getRecordNumber() Returns the number of this record in the parsed CSV file.
boolean	hasComment() Checks whether this record has a comment, false otherwise.
boolean	isConsistent() Tells whether the record size matches the header size.
boolean	isMapped(String name) Checks whether a given column is mapped, i.e. its name has been defined to the parser.
boolean	isSet(String name) Checks whether a given columns is mapped and has a value.
Iterator<String>	iterator() Returns an iterator over the values of this record.
int	size() Returns the number of values in this record.
Map<String,String>	toMap() Copies this record into a new Map of header name to record value.
String	toString() Returns a string representation of the contents of this record.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.lang.Iterable

forEach, spliterator

字段详细资料

serialVersionUID

public static final long serialVersionUID

另请参阅:

常量字段值

方法详细资料

get

public String get(Enum<?> e)

Returns a value by Enum.

参数:

e - an enum

返回:

the String at the given enum String

get

public String get(int i)

Returns a value by index.

参数:

i - a column index (0-based)

返回:

the String at the given index

get

public String get(String name)

Returns a value by name.

参数:

name - the name of the column to be retrieved.

返回:

the column value, maybe null depending on CsvFormat.getNullString().

抛出:

IllegalStateException - if no header mapping was provided

IllegalArgumentException - if name is not mapped or if the record is inconsistent

另请参阅:

isConsistent(), CsvFormat.withNullString(String)

getCharacterPosition

public long getCharacterPosition()

Returns the start position of this record as a character position in the source stream. This may or may not correspond to the byte position depending on the character set.

返回:

the position of this record in the source stream.

getComment

public String getComment()

Returns the comment for this record, if any. Note that comments are attached to the following record. If there is no following record (i.e. the comment is at EOF) the comment will be ignored.

返回:

the comment for this record, or null if no comment for this record is available.

getParser

public CsvParser getParser()

Returns the parser.

返回:

the parser.

从以下版本开始:

1.7

getRecordNumber

public long getRecordNumber()

Returns the number of this record in the parsed CSV file.

ATTENTION: If your CSV input has multi-line values, the returned number does not correspond to the current line number of the parser that created this record.

返回:

the number of this record.

另请参阅:

CsvParser.getCurrentLineNumber()

hasComment

public boolean hasComment()

Checks whether this record has a comment, false otherwise. Note that comments are attached to the following record. If there is no following record (i.e. the comment is at EOF) the comment will be ignored.

返回:

true if this record has a comment, false otherwise

从以下版本开始:

1.3

isConsistent

public boolean isConsistent()

Tells whether the record size matches the header size.

Returns true if the sizes for this record match and false if not. Some programs can export files that fail this test but still produce parsable files.

返回:

true of this record is valid, false if not

isMapped

public boolean isMapped(String name)

Checks whether a given column is mapped, i.e. its name has been defined to the parser.

参数:

name - the name of the column to be retrieved.

返回:

whether a given column is mapped.

isSet

public boolean isSet(String name)

Checks whether a given columns is mapped and has a value.

参数:

name - the name of the column to be retrieved.

返回:

whether a given columns is mapped and has a value

iterator

public Iterator<String> iterator()

Returns an iterator over the values of this record.

指定者:

iterator 在接口中 Iterable<String>

返回:

an iterator over the values of this record.

size

public int size()

Returns the number of values in this record.

返回:

the number of values.

toMap

public Map<String,String> toMap()

Copies this record into a new Map of header name to record value.

返回:

A new Map. The map is empty if the record has no headers.

toString

public String toString()

Returns a string representation of the contents of this record. The result is constructed by comment, mapping, recordNumber and by passing the internal values array to Arrays.toString(Object[]).

覆盖:

toString 在类中 Object

返回:

a String representation of this record.