Package io.substrait.relation.files

Class ImmutableFileFormat.DelimiterSeparatedTextReadOptions

java.lang.Object

io.substrait.relation.files.FileFormat.DelimiterSeparatedTextReadOptions

io.substrait.relation.files.ImmutableFileFormat.DelimiterSeparatedTextReadOptions

All Implemented Interfaces:

FileFormat

Enclosing class:

ImmutableFileFormat

public static final class ImmutableFileFormat.DelimiterSeparatedTextReadOptions
extends FileFormat.DelimiterSeparatedTextReadOptions

Immutable implementation of FileFormat.DelimiterSeparatedTextReadOptions.

Use the builder to create immutable instances: ImmutableFileFormat.DelimiterSeparatedTextReadOptions.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	Builds instances of type DelimiterSeparatedTextReadOptions.

Nested classes/interfaces inherited from interface io.substrait.relation.files.FileFormat

FileFormat.ArrowReadOptions, FileFormat.DelimiterSeparatedTextReadOptions, FileFormat.DwrfReadOptions, FileFormat.Extension, FileFormat.OrcReadOptions, FileFormat.ParquetReadOptions

Method Summary

Modifier and Type	Method	Description
static ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	builder()	Creates a builder for DelimiterSeparatedTextReadOptions.
static ImmutableFileFormat.DelimiterSeparatedTextReadOptions	copyOf(FileFormat.DelimiterSeparatedTextReadOptions instance)	Creates an immutable copy of a FileFormat.DelimiterSeparatedTextReadOptions value.
boolean	equals(Object another)	This instance is equal to all instances of DelimiterSeparatedTextReadOptions that have equal attribute values.
String	getEscape()
String	getFieldDelimiter()
long	getHeaderLinesToSkip()
long	getMaxLineSize()
String	getQuote()
Optional<String>	getValueTreatedAsNull()
int	hashCode()	Computes a hash code from attributes: fieldDelimiter, maxLineSize, quote, headerLinesToSkip, escape, valueTreatedAsNull.
String	toString()	Prints the immutable value DelimiterSeparatedTextReadOptions with attribute values.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions	withEscape(String value)	Copy the current immutable object by setting a value for the escape attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions	withFieldDelimiter(String value)	Copy the current immutable object by setting a value for the fieldDelimiter attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions	withHeaderLinesToSkip(long value)	Copy the current immutable object by setting a value for the headerLinesToSkip attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions	withMaxLineSize(long value)	Copy the current immutable object by setting a value for the maxLineSize attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions	withQuote(String value)	Copy the current immutable object by setting a value for the quote attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions	withValueTreatedAsNull(String value)	Copy the current immutable object by setting a present value for the optional valueTreatedAsNull attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions	withValueTreatedAsNull(Optional<String> optional)	Copy the current immutable object by setting an optional value for the valueTreatedAsNull attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getFieldDelimiter

public String getFieldDelimiter()

Specified by:

getFieldDelimiter in class FileFormat.DelimiterSeparatedTextReadOptions

Returns:

The value of the fieldDelimiter attribute

getMaxLineSize

public long getMaxLineSize()

Specified by:

getMaxLineSize in class FileFormat.DelimiterSeparatedTextReadOptions

Returns:

The value of the maxLineSize attribute

getQuote

public String getQuote()

Specified by:

getQuote in class FileFormat.DelimiterSeparatedTextReadOptions

Returns:

The value of the quote attribute

getHeaderLinesToSkip

public long getHeaderLinesToSkip()

Specified by:

getHeaderLinesToSkip in class FileFormat.DelimiterSeparatedTextReadOptions

Returns:

The value of the headerLinesToSkip attribute

getEscape

public String getEscape()

Specified by:

getEscape in class FileFormat.DelimiterSeparatedTextReadOptions

Returns:

The value of the escape attribute

getValueTreatedAsNull

public Optional<String> getValueTreatedAsNull()

Specified by:

getValueTreatedAsNull in class FileFormat.DelimiterSeparatedTextReadOptions

Returns:

The value of the valueTreatedAsNull attribute

withFieldDelimiter

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions withFieldDelimiter(String value)

Copy the current immutable object by setting a value for the fieldDelimiter attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for fieldDelimiter

Returns:

A modified copy or the this object

withMaxLineSize

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions withMaxLineSize(long value)

Copy the current immutable object by setting a value for the maxLineSize attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for maxLineSize

Returns:

A modified copy or the this object

withQuote

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions withQuote(String value)

Copy the current immutable object by setting a value for the quote attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for quote

Returns:

A modified copy or the this object

withHeaderLinesToSkip

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions withHeaderLinesToSkip(long value)

Copy the current immutable object by setting a value for the headerLinesToSkip attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for headerLinesToSkip

Returns:

A modified copy or the this object

withEscape

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions withEscape(String value)

Copy the current immutable object by setting a value for the escape attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for escape

Returns:

A modified copy or the this object

withValueTreatedAsNull

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions withValueTreatedAsNull(String value)

Copy the current immutable object by setting a present value for the optional valueTreatedAsNull attribute.

Parameters:

value - The value for valueTreatedAsNull

Returns:

A modified copy or this if not changed

withValueTreatedAsNull

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions withValueTreatedAsNull(Optional<String> optional)

Copy the current immutable object by setting an optional value for the valueTreatedAsNull attribute. An equality check is used on inner value to prevent copying of the same value by returning this.

Parameters:

optional - An optional value for valueTreatedAsNull

Returns:

A modified copy or this if not changed

equals

public boolean equals(Object another)

This instance is equal to all instances of DelimiterSeparatedTextReadOptions that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: fieldDelimiter, maxLineSize, quote, headerLinesToSkip, escape, valueTreatedAsNull.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value DelimiterSeparatedTextReadOptions with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableFileFormat.DelimiterSeparatedTextReadOptions copyOf(FileFormat.DelimiterSeparatedTextReadOptions instance)

Creates an immutable copy of a FileFormat.DelimiterSeparatedTextReadOptions value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable DelimiterSeparatedTextReadOptions instance

builder

public static ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder builder()

Creates a builder for DelimiterSeparatedTextReadOptions.

 ImmutableFileFormat.DelimiterSeparatedTextReadOptions.builder()
    .fieldDelimiter(String) // required fieldDelimiter
    .maxLineSize(long) // required maxLineSize
    .quote(String) // required quote
    .headerLinesToSkip(long) // required headerLinesToSkip
    .escape(String) // required escape
    .valueTreatedAsNull(Optional<String>) // optional valueTreatedAsNull
    .build();
 

Returns:

A new DelimiterSeparatedTextReadOptions builder