CSVInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.s3.model.CSVInput

All Implemented Interfaces:

Serializable, Cloneable
```
public class CSVInput
extends Object
implements Serializable, Cloneable
```
Describes how a CSV-formatted input object is formatted.

See Also:

InputSerialization, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CSVInput()

Constructors
Constructor and Description
`CSVInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CSVInput`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowQuotedRecordDelimiter()`
`Character`	`getComments()`
`String`	`getCommentsAsString()`
`Character`	`getFieldDelimiter()`
`String`	`getFieldDelimiterAsString()`
`String`	`getFileHeaderInfo()`
`Character`	`getQuoteCharacter()`
`String`	`getQuoteCharacterAsString()`
`Character`	`getQuoteEscapeCharacter()`
`String`	`getQuoteEscapeCharacterAsString()`
`Character`	`getRecordDelimiter()`
`String`	`getRecordDelimiterAsString()`
`int`	`hashCode()`
`void`	`setAllowQuotedRecordDelimiter(Boolean allowQuotedRecordDelimiter)` Sets the value used to allow quoted record delimiters to occur within the input.
`void`	`setComments(Character comments)` Sets the character used to indicate a row should be ignored when present at the start of a row.
`void`	`setComments(String comments)` Sets the character used to indicate a row should be ignored when present at the start of a row.
`void`	`setFieldDelimiter(Character fieldDelimiter)` Sets the value used to separate individual fields in a record.
`void`	`setFieldDelimiter(String fieldDelimiter)` Sets the value used to separate individual fields in a record.
`void`	`setFileHeaderInfo(FileHeaderInfo fileHeaderInfo)` Sets the first line of input.
`void`	`setFileHeaderInfo(String fileHeaderInfo)` Sets the first line of input.
`void`	`setQuoteCharacter(Character quoteCharacter)` Sets the value used for escaping where the field delimiter is part of the value.
`void`	`setQuoteCharacter(String quoteCharacter)` Sets the value used for escaping where the field delimiter is part of the value.
`void`	`setQuoteEscapeCharacter(Character quoteEscapeCharacter)` Sets the character used for escaping the quote character inside an already escaped value.
`void`	`setQuoteEscapeCharacter(String quoteEscapeCharacter)` Sets the character used for escaping the quote character inside an already escaped value.
`void`	`setRecordDelimiter(Character recordDelimiter)` Sets the value used to separate individual records.
`void`	`setRecordDelimiter(String recordDelimiter)` Sets the value used to separate individual records.
`String`	`toString()`
`CSVInput`	`withAllowQuotedRecordDelimiter(Boolean allowQuotedRecordDelimiter)` Sets the value used to allow quoted record delimiters to occur within the input.
`CSVInput`	`withComments(Character comments)` Sets the Single character used to indicate a row should be ignored when present at the start of a row.
`CSVInput`	`withComments(String comments)` Sets the character used to indicate a row should be ignored when present at the start of a row.
`CSVInput`	`withFieldDelimiter(Character fieldDelimiter)` Sets the value used to separate individual fields in a record.
`CSVInput`	`withFieldDelimiter(String fieldDelimiter)` Sets the value used to separate individual fields in a record.
`CSVInput`	`withFileHeaderInfo(FileHeaderInfo fileHeaderInfo)` Sets the fileHeaderInfo
`CSVInput`	`withFileHeaderInfo(String fileHeaderInfo)` Sets the fileHeaderInfo
`CSVInput`	`withQuoteCharacter(Character quoteCharacter)` Sets the value used for escaping where the field delimiter is part of the value.
`CSVInput`	`withQuoteCharacter(String quoteCharacter)` Sets the value used for escaping where the field delimiter is part of the value.
`CSVInput`	`withQuoteEscapeCharacter(Character quoteEscapeCharacter)` Sets the character used for escaping the quote character inside an already escaped value.
`CSVInput`	`withQuoteEscapeCharacter(String quoteEscapeCharacter)` Sets the character used for escaping the quote character inside an already escaped value.
`CSVInput`	`withRecordDelimiter(Character recordDelimiter)` Sets the value used to separate individual records.
`CSVInput`	`withRecordDelimiter(String recordDelimiter)` Sets the value used to separate individual records.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CSVInput
```
public CSVInput()
```
- Method Detail
  - getFileHeaderInfo
```
public String getFileHeaderInfo()
```
    Returns:
    
    the first line of input. Valid values: None, Ignore, Use.
  - setFileHeaderInfo
```
public void setFileHeaderInfo(String fileHeaderInfo)
```
    Sets the first line of input. Valid values: None, Ignore, Use.
    
    Parameters:
    
    fileHeaderInfo - New file header info value
  - withFileHeaderInfo
```
public CSVInput withFileHeaderInfo(String fileHeaderInfo)
```
    Sets the fileHeaderInfo
    
    Parameters:
    
    fileHeaderInfo - The new fileHeaderInfo value.
    
    Returns:
    
    This object for method chaining.
  - setFileHeaderInfo
```
public void setFileHeaderInfo(FileHeaderInfo fileHeaderInfo)
```
    Sets the first line of input. Valid values: None, Ignore, Use.
    
    Parameters:
    
    fileHeaderInfo - New file header info value
  - withFileHeaderInfo
```
public CSVInput withFileHeaderInfo(FileHeaderInfo fileHeaderInfo)
```
    Sets the fileHeaderInfo
    
    Parameters:
    
    fileHeaderInfo - The new fileHeaderInfo value.
    
    Returns:
    
    This object for method chaining.
  - getComments
```
public Character getComments()
```
    Returns:
    
    Character used to indicate a row should be ignored when present at the start of a row. If it was set with setComments(String), this will return the first character in the string.
    
    See Also:
    
    to retrieve the full value.
  - getCommentsAsString
```
public String getCommentsAsString()
```
    Returns:
    
    Character used to indicate a row should be ignored when present at the start of a row.
  - setComments
```
public void setComments(String comments)
```
    Sets the character used to indicate a row should be ignored when present at the start of a row.
    
    Parameters:
    
    comments - New comments value
  - withComments
```
public CSVInput withComments(String comments)
```
    Sets the character used to indicate a row should be ignored when present at the start of a row.
    
    Parameters:
    
    comments - The new comments value.
    
    Returns:
    
    This object for method chaining.
  - setComments
```
public void setComments(Character comments)
```
    Sets the character used to indicate a row should be ignored when present at the start of a row.
    
    Parameters:
    
    comments - New comments value
  - withComments
```
public CSVInput withComments(Character comments)
```
    Sets the Single character used to indicate a row should be ignored when present at the start of a row.
    
    Parameters:
    
    comments - The new comments value.
    
    Returns:
    
    This object for method chaining.
  - getQuoteEscapeCharacter
```
public Character getQuoteEscapeCharacter()
```
    Returns:
    
    Character used for escaping the quote character inside an already escaped value. If it was set with setQuoteEscapeCharacter(String), this will return the first character in the string.
    
    See Also:
    
    to retrieve the full value.
  - getQuoteEscapeCharacterAsString
```
public String getQuoteEscapeCharacterAsString()
```
    Returns:
    
    Character used for escaping the quote character inside an already escaped value.
  - setQuoteEscapeCharacter
```
public void setQuoteEscapeCharacter(String quoteEscapeCharacter)
```
    Sets the character used for escaping the quote character inside an already escaped value.
    
    Parameters:
    
    quoteEscapeCharacter - New quoteEscapeCharacter value
  - withQuoteEscapeCharacter
```
public CSVInput withQuoteEscapeCharacter(String quoteEscapeCharacter)
```
    Sets the character used for escaping the quote character inside an already escaped value.
    
    Parameters:
    
    quoteEscapeCharacter - The new quoteEscapeCharacter value.
    
    Returns:
    
    This object for method chaining.
  - setQuoteEscapeCharacter
```
public void setQuoteEscapeCharacter(Character quoteEscapeCharacter)
```
    Sets the character used for escaping the quote character inside an already escaped value.
    
    Parameters:
    
    quoteEscapeCharacter - New quoteEscapeCharacter value
  - withQuoteEscapeCharacter
```
public CSVInput withQuoteEscapeCharacter(Character quoteEscapeCharacter)
```
    Sets the character used for escaping the quote character inside an already escaped value.
    
    Parameters:
    
    quoteEscapeCharacter - The new quoteEscapeCharacter value.
    
    Returns:
    
    This object for method chaining.
  - getRecordDelimiter
```
public Character getRecordDelimiter()
```
    Returns:
    
    The value used to separate individual records as a character. If it was set with setRecordDelimiter(String), this will return the first character in the string.
    
    See Also:
    
    to retrieve the value.
  - getRecordDelimiterAsString
```
public String getRecordDelimiterAsString()
```
    Returns:
    
    The value used to separate individual records.
  - setRecordDelimiter
```
public void setRecordDelimiter(String recordDelimiter)
```
    Sets the value used to separate individual records.
    
    Parameters:
    
    recordDelimiter - New recordDelimiter value
  - withRecordDelimiter
```
public CSVInput withRecordDelimiter(String recordDelimiter)
```
    Sets the value used to separate individual records.
    
    Parameters:
    
    recordDelimiter - The new recordDelimiter value.
    
    Returns:
    
    This object for method chaining.
  - setRecordDelimiter
```
public void setRecordDelimiter(Character recordDelimiter)
```
    Sets the value used to separate individual records.
    
    Parameters:
    
    recordDelimiter - New recordDelimiter value
  - withRecordDelimiter
```
public CSVInput withRecordDelimiter(Character recordDelimiter)
```
    Sets the value used to separate individual records.
    
    Parameters:
    
    recordDelimiter - The new recordDelimiter value.
    
    Returns:
    
    This object for method chaining.
  - getFieldDelimiter
```
public Character getFieldDelimiter()
```
    Returns:
    
    The value used to separate individual fields in a record. If it was set with setFieldDelimiter(String), this will return the first character in the string.
    
    See Also:
    
    to retrieve the value.
  - getFieldDelimiterAsString
```
public String getFieldDelimiterAsString()
```
    Returns:
    
    The value used to separate individual fields in a record.
  - setFieldDelimiter
```
public void setFieldDelimiter(String fieldDelimiter)
```
    Sets the value used to separate individual fields in a record.
    
    Parameters:
    
    fieldDelimiter - New fieldDelimiter value
  - withFieldDelimiter
```
public CSVInput withFieldDelimiter(String fieldDelimiter)
```
    Sets the value used to separate individual fields in a record.
    
    Parameters:
    
    fieldDelimiter - The new fieldDelimiter value.
    
    Returns:
    
    This object for method chaining.
  - setFieldDelimiter
```
public void setFieldDelimiter(Character fieldDelimiter)
```
    Sets the value used to separate individual fields in a record.
    
    Parameters:
    
    fieldDelimiter - New fieldDelimiter value
  - withFieldDelimiter
```
public CSVInput withFieldDelimiter(Character fieldDelimiter)
```
    Sets the value used to separate individual fields in a record.
    
    Parameters:
    
    fieldDelimiter - The new fieldDelimiter value.
    
    Returns:
    
    This object for method chaining.
  - getQuoteCharacter
```
public Character getQuoteCharacter()
```
    Returns:
    
    The value used for escaping where the field delimiter is part of the value. If it was set with setQuoteCharacter(String), this will return the first character in the string.
    
    See Also:
    
    to retrieve the value.
  - getQuoteCharacterAsString
```
public String getQuoteCharacterAsString()
```
    Returns:
    
    The value used for escaping where the field delimiter is part of the value.
  - setQuoteCharacter
```
public void setQuoteCharacter(String quoteCharacter)
```
    Sets the value used for escaping where the field delimiter is part of the value.
    
    Parameters:
    
    quoteCharacter - New quoteCharacter value
  - withQuoteCharacter
```
public CSVInput withQuoteCharacter(String quoteCharacter)
```
    Sets the value used for escaping where the field delimiter is part of the value.
    
    Parameters:
    
    quoteCharacter - The new quoteCharacter value.
    
    Returns:
    
    This object for method chaining.
  - setQuoteCharacter
```
public void setQuoteCharacter(Character quoteCharacter)
```
    Sets the value used for escaping where the field delimiter is part of the value.
    
    Parameters:
    
    quoteCharacter - New quoteCharacter value
  - withQuoteCharacter
```
public CSVInput withQuoteCharacter(Character quoteCharacter)
```
    Sets the value used for escaping where the field delimiter is part of the value.
    
    Parameters:
    
    quoteCharacter - The new quoteCharacter value.
    
    Returns:
    
    This object for method chaining.
  - getAllowQuotedRecordDelimiter
```
public Boolean getAllowQuotedRecordDelimiter()
```
    Returns:
    
    The value used to allow quoted record delimiters to occur within the input.
  - setAllowQuotedRecordDelimiter
```
public void setAllowQuotedRecordDelimiter(Boolean allowQuotedRecordDelimiter)
```
    Sets the value used to allow quoted record delimiters to occur within the input.
    
    Parameters:
    
    allowQuotedRecordDelimiter - New allowQuotedRecordDelimiter value.
  - withAllowQuotedRecordDelimiter
```
public CSVInput withAllowQuotedRecordDelimiter(Boolean allowQuotedRecordDelimiter)
```
    Sets the value used to allow quoted record delimiters to occur within the input.
    
    Parameters:
    
    allowQuotedRecordDelimiter - New allowQuotedRecordDelimiter value.
    
    Returns:
    
    This object for method chaining.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public CSVInput clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class CSVInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CSVInput

Method Detail

getFileHeaderInfo

setFileHeaderInfo

withFileHeaderInfo

setFileHeaderInfo

withFileHeaderInfo

getComments

getCommentsAsString

setComments

withComments

setComments

withComments

getQuoteEscapeCharacter

getQuoteEscapeCharacterAsString

setQuoteEscapeCharacter

withQuoteEscapeCharacter

setQuoteEscapeCharacter

withQuoteEscapeCharacter

getRecordDelimiter

getRecordDelimiterAsString

setRecordDelimiter

withRecordDelimiter

setRecordDelimiter

withRecordDelimiter

getFieldDelimiter

getFieldDelimiterAsString

setFieldDelimiter

withFieldDelimiter

setFieldDelimiter

withFieldDelimiter

getQuoteCharacter

getQuoteCharacterAsString

setQuoteCharacter

withQuoteCharacter

setQuoteCharacter

withQuoteCharacter

getAllowQuotedRecordDelimiter

setAllowQuotedRecordDelimiter

withAllowQuotedRecordDelimiter

equals

hashCode

toString

clone