Class

za.co.absa.cobrix.spark.cobol.parameters

Parameters

Related Doc: package parameters

Permalink

class Parameters extends AnyRef

Wraps parameters provided by spark.read.option(...) in order to track which parameters are actually used/recognized.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Parameters
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Parameters(params: Map[String, String])

params
Parameters provided by spark.read.option(...)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def apply(key: String): String

Gets a value from the underlying parameters map tracking its usage.
Gets a value from the underlying parameters map tracking its usage.
key
A key to the parameters map
returns
A value associated with the key
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contains(key: String): Boolean

Returns true if a key is present in the underlying map tracking its usage.
Returns true if a key is present in the underlying map tracking its usage.
key
A key to the parameters map
returns
True if the key is present in the map
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(key: String): Option[String]

Gets a value from the underlying parameters map tracking its usage.
Gets a value from the underlying parameters map tracking its usage.
key
A key to the parameters map
returns
An option boxed value associated with the key
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getMap: Map[String, String]

Returns the underlying map.
Returns the underlying map. This is used for getting spark-cobol options by enumerating the map itself.
returns
The underlying parameters map
def getOrElse(key: String, default: ⇒ String): String

Gets a value from the underlying parameters map tracking its usage.
Gets a value from the underlying parameters map tracking its usage.
key
A key to the parameters map
default
A default value that will be returned if the map does not contain the key.
returns
An value associated with the key or the default value if the key is not present in the map
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isKeyUsed(key: String): Boolean

Returns the underlying map.
Returns the underlying map. This is used for getting spark-cobol options by enumerating the map itself.
returns
True is the provided key was used for determining how a COBOL data need to be processed.
def markUsed(key: String): Unit

Marks that a key is actually used by 'spark-cobol'.
Marks that a key is actually used by 'spark-cobol'. The method is used when options are processed by enumerating the underlying map.
key
A key to the parameters map
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped