com.aimpulse.spectrum.mas.fipa.df

Class ServiceDescriptionBuilder

java.lang.Object

com.aimpulse.spectrum.mas.fipa.df.ServiceDescriptionBuilder

public class ServiceDescriptionBuilder
extends Object

A convenient builder for service descriptions.

In Eclipse, you can register this class as a favorite ("Preferences" - "Java" - "Editor" - "Content Assist" - "Favorites"). Content assist will then propose the builder even if the import is missing.

Since:

1.0.0

Author:

Aimpulse

See Also:

ServiceDescription, ServiceDescriptionBuffer, FIPA Agent Management Specification, Section 6.1.3

Method Summary

Methods

Modifier and Type	Method and Description
static ServiceDescriptionBuilder	aService() Creates a builder for service descriptions.
ServiceDescription	build() Builds the service description defined by this builder.
ServiceDescriptionBuilder	byOwner(Ownership ownership) Sets the owner of the service.
ServiceDescriptionBuilder	named(ServiceIdentifier name) Sets the name of the service.
ServiceDescriptionBuilder	ofType(ServiceType type) Sets the type of the service.
ServiceDescriptionBuilder	supporting(ProtocolIdentifier protocol) Adds a supported protocol to the description.
ServiceDescriptionBuilder	understanding(LanguageIdentifier language) Adds a language to the description.
ServiceDescriptionBuilder	understanding(OntologyIdentifier ontology) Adds an ontology to the description.
ServiceDescriptionBuilder	withProperty(Property property) Adds a property to the description.

Methods inherited from class java.lang.Object

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

Method Detail

aService

public static ServiceDescriptionBuilder aService()

Creates a builder for service descriptions.

Returns:

the builder for service descriptions

named

public ServiceDescriptionBuilder named(ServiceIdentifier name)

Sets the name of the service.

Parameters:

name - the name of the service

Returns:

the service description builder

Throws:

IllegalStateException - if the name is already set

NullPointerException - if the name is null

ofType

public ServiceDescriptionBuilder ofType(ServiceType type)

Sets the type of the service.

Parameters:

type - the type of the service

Returns:

the service description builder

Throws:

IllegalStateException - if the name is already set

NullPointerException - if the name is null

supporting

public ServiceDescriptionBuilder supporting(ProtocolIdentifier protocol)

Adds a supported protocol to the description.

Parameters:

protocol - the protocol to be added

Returns:

the service description builder

Throws:

NullPointerException - if the protocol is null

understanding

public ServiceDescriptionBuilder understanding(OntologyIdentifier ontology)

Adds an ontology to the description.

Parameters:

ontology - the ontology to be added

Returns:

the service description builder

Throws:

NullPointerException - if the ontology is null

understanding

public ServiceDescriptionBuilder understanding(LanguageIdentifier language)

Adds a language to the description.

Parameters:

language - the language to be added

Returns:

the service description builder

Throws:

NullPointerException - if the language is null

byOwner

public ServiceDescriptionBuilder byOwner(Ownership ownership)

Sets the owner of the service.

Parameters:

ownership - the owner of the service

Returns:

the service description builder

Throws:

IllegalStateException - if the name is already set

NullPointerException - if the name is null

withProperty

public ServiceDescriptionBuilder withProperty(Property property)

Adds a property to the description.

Parameters:

property - the language to be added

Returns:

the service description builder

Throws:

NullPointerException - if the property is null

build

public ServiceDescription build()

Builds the service description defined by this builder.

Returns:

the service description defined by this builder