com.luciad.datamodels

Class DataProperty.Builder

java.lang.Object

com.luciad.datamodels.DataProperty.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

DataProperty

public static final class DataProperty.Builder
extends Object
implements AutoCloseable

Builder that allows DataProperty instances to be created.

Typical usage would be create a DataProperty.Builder using DataProperty#newBuilder, specifying the data property's name. Then specify the value type and finally build() the data property. The following snippet shows how this is done for a simple example data property:

    return DataProperty.newBuilder()
                       .name("geometry")
                       .valueType(DataType.getGeometryType())
                       .build();

Constructor Summary

Constructors

Constructor and Description
Builder(DataProperty.Builder other)

Method Summary

Modifier and Type	Method and Description
DataProperty	build() Build the data type, including the value type that was set on this builder.
void	close()
protected void	finalize()
DataProperty.Builder	name(String name) Sets the name of the data property.
DataProperty.Builder	valueType(DataType type) Sets the data type for the data property under construction.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NotNull
               DataProperty.Builder other)

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

build

@NotNull
public DataProperty build()
                            throws IllegalStateException

Build the data type, including the value type that was set on this builder.

After calling this function, this builder should no longer be used.

Returns:

the data type.

Throws:

IllegalStateException - If not all mandatory parameters are set.

valueType

@NotNull
public DataProperty.Builder valueType(@NotNull
                                               DataType type)

Sets the data type for the data property under construction.

Calling this function is mandatory.

Parameters:

type - the data type for the data property under construction.

Returns:

this builder.

name

@NotNull
public DataProperty.Builder name(@NotNull
                                          String name)

Sets the name of the data property.

Calling this function is mandatory.

Parameters:

name - name of the data property.

Returns:

this builder.