ClassInstance (flink 1.11-SNAPSHOT API)

java.lang.Object
- org.apache.flink.table.descriptors.HierarchyDescriptor
- - org.apache.flink.table.descriptors.ClassInstance

All Implemented Interfaces:

Descriptor
```
@PublicEvolving
public class ClassInstance
extends HierarchyDescriptor
```
Descriptor for a class instance. A class instance is a Java/Scala object created from a class with a public constructor (with or without parameters).

Constructor Summary

Constructors
Constructor and Description

ClassInstance()

Constructors
Constructor and Description
`ClassInstance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertiesWithPrefix(String keyPrefix, DescriptorProperties properties)` Internal method for properties conversion.
`ClassInstance`	`of(String className)` Sets the fully qualified class name for creating an instance.
`ClassInstance`	`parameter(BigDecimal value)` Adds a constructor parameter value of DECIMAL type.
`ClassInstance`	`parameter(boolean value)` Adds a constructor parameter value of BOOLEAN type.
`ClassInstance`	`parameter(byte value)` Adds a constructor parameter value of TINYINT type.
`ClassInstance`	`parameter(ClassInstance classInstance)` Adds a constructor parameter value of a class instance (i.e.
`ClassInstance`	`parameter(double value)` Adds a constructor parameter value of DOUBLE type.
`ClassInstance`	`parameter(float value)` Adds a constructor parameter value of FLOAT type.
`ClassInstance`	`parameter(int value)` Adds a constructor parameter value of INT type.
`ClassInstance`	`parameter(long value)` Adds a constructor parameter value of BIGINT type.
`ClassInstance`	`parameter(short value)` Adds a constructor parameter value of SMALLINT type.
`ClassInstance`	`parameter(String value)` Adds a constructor parameter value of VARCHAR type.
`ClassInstance`	`parameter(String typeString, String valueString)` Adds a constructor parameter value of literal type.
`ClassInstance`	`parameter(TypeInformation<?> typeInfo, String valueString)` Adds a constructor parameter value of literal type.
`ClassInstance`	`parameterString(String valueString)` Adds a constructor parameter value of literal type.
`Map<String,String>`	`toProperties()` Converts this descriptor into a set of properties.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClassInstance
```
public ClassInstance()
```
- Method Detail
  - of
```
public ClassInstance of(String className)
```
    Sets the fully qualified class name for creating an instance.
    E.g. org.example.MyClass or org.example.MyClass$StaticInnerClass
    
    Parameters:
    
    className - fully qualified class name
  - parameterString
```
public ClassInstance parameterString(String valueString)
```
    Adds a constructor parameter value of literal type. The type is automatically derived from the value. Currently, this is supported for: BOOLEAN, INT, DOUBLE, and VARCHAR. Expression values are not allowed.
    Examples: - "true", "false" -> BOOLEAN - "42", "-5" -> INT - "2.0", "1234.222" -> DOUBLE - VARCHAR otherwise
    For other types and explicit type declaration use parameter(String, String) or parameter(TypeInformation, String).
  - parameter
```
public ClassInstance parameter(String typeString,
                               String valueString)
```
    Adds a constructor parameter value of literal type. The type is explicitly defined using a type string such as VARCHAR, FLOAT, BOOLEAN, INT, BIGINT, etc. The value is parsed accordingly. Expression values are not allowed.
    
    Parameters:
    
    typeString - the type string that define how to parse the given value string
    
    valueString - the literal value to be parsed
  - parameter
```
public ClassInstance parameter(TypeInformation<?> typeInfo,
                               String valueString)
```
    Adds a constructor parameter value of literal type. The type is explicitly defined using type information. The value is parsed accordingly. Expression values are not allowed.
    
    Parameters:
    
    typeInfo - the type that define how to parse the given value string
    
    valueString - the literal value to be parsed
  - parameter
```
public ClassInstance parameter(boolean value)
```
    Adds a constructor parameter value of BOOLEAN type.
    
    Parameters:
    
    value - BOOLEAN value
  - parameter
```
public ClassInstance parameter(double value)
```
    Adds a constructor parameter value of DOUBLE type.
    
    Parameters:
    
    value - DOUBLE value
  - parameter
```
public ClassInstance parameter(float value)
```
    Adds a constructor parameter value of FLOAT type.
    
    Parameters:
    
    value - FLOAT value
  - parameter
```
public ClassInstance parameter(int value)
```
    Adds a constructor parameter value of INT type.
    
    Parameters:
    
    value - INT value
  - parameter
```
public ClassInstance parameter(String value)
```
    Adds a constructor parameter value of VARCHAR type.
    
    Parameters:
    
    value - VARCHAR value
  - parameter
```
public ClassInstance parameter(long value)
```
    Adds a constructor parameter value of BIGINT type.
    
    Parameters:
    
    value - BIGINT value
  - parameter
```
public ClassInstance parameter(byte value)
```
    Adds a constructor parameter value of TINYINT type.
    
    Parameters:
    
    value - TINYINT value
  - parameter
```
public ClassInstance parameter(short value)
```
    Adds a constructor parameter value of SMALLINT type.
    
    Parameters:
    
    value - SMALLINT value
  - parameter
```
public ClassInstance parameter(BigDecimal value)
```
    Adds a constructor parameter value of DECIMAL type.
    
    Parameters:
    
    value - DECIMAL value
  - parameter
```
public ClassInstance parameter(ClassInstance classInstance)
```
    Adds a constructor parameter value of a class instance (i.e. a Java object with a public constructor).
    
    Parameters:
    
    classInstance - description of a class instance (i.e. a Java object with a public constructor).
  - toProperties
```
public Map<String,String> toProperties()
```
    Converts this descriptor into a set of properties.
  - addPropertiesWithPrefix
```
public void addPropertiesWithPrefix(String keyPrefix,
                                    DescriptorProperties properties)
```
    Internal method for properties conversion.
    
    Specified by:
    
    addPropertiesWithPrefix in class HierarchyDescriptor

Back to Flink Website

Class ClassInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClassInstance

Method Detail

of

parameterString

parameter

parameter

parameter

parameter

parameter

parameter

parameter

parameter

parameter

parameter

parameter

parameter

toProperties

addPropertiesWithPrefix