Package com.luciad.fusion.tilestore

Class TLfnTileStoreMetadata.Builder

java.lang.Object

com.luciad.fusion.tilestore.TLfnTileStoreMetadata.Builder

Enclosing class:

TLfnTileStoreMetadata

public static class TLfnTileStoreMetadata.Builder
extends Object

Builder for service metadata. Required parameters that must be set before calling build() are:

• the ID, via id(java.lang.String)

If one of those required parameters has not been set properly, the build with throw a NullPointerException. All other parameters are optional.

A builder can be reused to build multiple metadata objects, but it is not thread-safe.

Since:

10.0

Method Summary

Modifier and Type	Method	Description
TLfnTileStoreMetadata.Builder	abstract_(String aAbstract)	Sets the abstract.
TLfnTileStoreMetadata	build()	Builds an immutable service metadata.
TLfnTileStoreMetadata.Builder	id(String aId)	Sets the service ID, which is a required parameter.
TLfnTileStoreMetadata.Builder	keywords(String... aKeywords)	Sets the keywords.
TLfnTileStoreMetadata.Builder	keywords(Collection<String> aKeywords)	Sets the keywords.
TLfnTileStoreMetadata.Builder	name(String aName)	Sets the name.
TLfnTileStoreMetadata.Builder	setAbstract(String aAbstract)	Deprecated. use abstract_(String) instead
TLfnTileStoreMetadata.Builder	setId(String aId)	Deprecated. use id(String) instead
TLfnTileStoreMetadata.Builder	setKeywords(String... aKeywords)	Deprecated. use keywords(String...) instead
TLfnTileStoreMetadata.Builder	setKeywords(Collection<String> aKeywords)	Deprecated. use keywords(java.util.Collection) instead
TLfnTileStoreMetadata.Builder	setName(String aName)	Deprecated. use name(String) instead

Methods inherited from class java.lang.Object

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

Method Details

id

public TLfnTileStoreMetadata.Builder id(String aId)

Sets the service ID, which is a required parameter.

Parameters:

aId - the ID to set, must not be null. Note that if null is given, this method does not throw, but a subsequent call to build() will.

Returns:

this builder

Since:

2013.0

setId

public TLfnTileStoreMetadata.Builder setId(String aId)

Deprecated.

use id(String) instead

name

public TLfnTileStoreMetadata.Builder name(String aName)

Sets the name.

Parameters:

aName - the name to set, may be null

Returns:

this builder

Since:

2013.0

setName

public TLfnTileStoreMetadata.Builder setName(String aName)

Deprecated.

use name(String) instead

abstract_

public TLfnTileStoreMetadata.Builder abstract_(String aAbstract)

Sets the abstract. The trailing underscore in the method name is necessary to avoid conflict with the reserved Java keyword abstract.

Parameters:

aAbstract - the abstract to set, may be null

Returns:

this builder

Since:

2013.0

setAbstract

public TLfnTileStoreMetadata.Builder setAbstract(String aAbstract)

Deprecated.

use abstract_(String) instead

keywords

public TLfnTileStoreMetadata.Builder keywords(Collection<String> aKeywords)

Sets the keywords.

Parameters:

aKeywords - the keywords to set, must not be null

Returns:

this builder

Since:

2013.0

setKeywords

public TLfnTileStoreMetadata.Builder setKeywords(Collection<String> aKeywords)

Deprecated.

use keywords(java.util.Collection) instead

keywords

public TLfnTileStoreMetadata.Builder keywords(String... aKeywords)

Sets the keywords.

Parameters:

aKeywords - the keywords to set, must not be null

Returns:

this builder

Since:

2013.0

setKeywords

public TLfnTileStoreMetadata.Builder setKeywords(String... aKeywords)

Deprecated.

use keywords(String...) instead

build

public TLfnTileStoreMetadata build()

Builds an immutable service metadata. Note that, depending on the builder implementation, this is not necessarily a new object. Builders may optimize memory usage by returning the same objects, for instance if no parameters were modified in between two subsequent calls to this method.

Returns:

the immutable service metadata

Throws:

NullPointerException - in case one or more required parameters have not been set