Package de.iip_ecosphere.platform.connectors

Class ConnectorField

java.lang.Object

de.iip_ecosphere.platform.connectors.ConnectorField

public class ConnectorField
extends Object

Descriptive information about a connector field.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConnectorField.ConnectorFieldBuilder	Builds a connector field.

Field Summary

Fields

Modifier and Type	Field	Description
private String	name
private String	nativeId
private String	nativeType
private String	path

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConnectorField()	Creates a connector field instance.

Method Summary

Modifier and Type	Method	Description
static ConnectorField.ConnectorFieldBuilder	builder(String name)	Returns a ConnectorField.ConnectorFieldBuilder.
String	getName()	Returns the name of the field.
String	getNativeId()	Returns the native id as used in/by the protocol.
String	getNativeType()	Returns the native type as used in/by the protocol.
String	getPath()	Returns the access path to the field.
static void	printFields(List<ConnectorField> fields, PrintStream out)	Helper function to print connector fields with a default formatter to out.
static void	printFields(List<ConnectorField> fields, Function<ConnectorField,String> formatter, PrintStream out)	Helper function to print connector fields with a default formatter to out.

Methods inherited from class java.lang.Object

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

Field Details

name

private String name

path

private String path

nativeType

private String nativeType

nativeId

private String nativeId

Constructor Details

ConnectorField

private ConnectorField()

Creates a connector field instance.

Method Details

builder

public static ConnectorField.ConnectorFieldBuilder builder(String name)

Returns a ConnectorField.ConnectorFieldBuilder.

Parameters:

name - the name of the field

Returns:

the builder

getName

public String getName()

Returns the name of the field.

Returns:

the name

getPath

public String getPath()

Returns the access path to the field.

Returns:

the path, by default the same as getName()

getNativeType

public String getNativeType()

Returns the native type as used in/by the protocol.

Returns:

the nativeType, may be null or empty if unknown/unused

getNativeId

public String getNativeId()

Returns the native id as used in/by the protocol.

Returns:

the nativeId, may be null or empty if unknown/unused

printFields

public static void printFields(List<ConnectorField> fields,
 PrintStream out)

Helper function to print connector fields with a default formatter to out.

Parameters:

fields - the fields to print

out - the output stream to print to

See Also:

• printFields(List, Function, PrintStream)

printFields

public static void printFields(List<ConnectorField> fields,
 Function<ConnectorField,String> formatter,
 PrintStream out)

Helper function to print connector fields with a default formatter to out.

Parameters:

fields - the fields to print

formatter - the field output formatter

out - the output stream to print to