de.fraunhofer.iese.ind2uce.api.component

Class ComponentBase

java.lang.Object

de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

de.fraunhofer.iese.ind2uce.api.component.ComponentBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Component, PepComponent

@Entity
public abstract class ComponentBase
extends Ind2uceEntity

Created by eitel on 12/1/16.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentId	id The unique ID of the Component.
protected List<URI>	urls A list of URIs that can be used to communicate with the Component.

Fields inherited from class de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

GSON_DEFAULT, GSON_PLAIN, GSON_PRETTY, version

Constructor Summary

Constructors

Constructor and Description
ComponentBase()
ComponentBase(ComponentId cId)
ComponentBase(ComponentId cId, List<URI> urls)

Method Summary

Modifier and Type	Method and Description
void	addUrl(URI url) Adds a URL to the list of URIs that can be used to communicate with the Component.
ComponentId	getId() Gets the unique ID of the Component.
ComponentType	getType() Returns the ComponentType of the component.
List<URI>	getUrls() Gets the a list of URIs that can be used to communicate with the Component.
List<URI>	getUrlsForProtocol(String... protocols) Provides a list of URLs of a certain protocol/scheme.
void	setId(ComponentId id) Sets the unique ID of the Component.
void	setUrls(List<URI> urls) Sets the a list of URIs that can be used to communicate with the Component.

Methods inherited from class de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

fromJson, getGson, getVersion, toJson, toString

Methods inherited from class java.lang.Object

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

Field Detail

id

protected ComponentId id

The unique ID of the Component.

urls

protected List<URI> urls

A list of URIs that can be used to communicate with the Component.

Constructor Detail

ComponentBase

public ComponentBase()

ComponentBase

public ComponentBase(ComponentId cId)

ComponentBase

public ComponentBase(ComponentId cId,
                     List<URI> urls)

Method Detail

addUrl

public void addUrl(URI url)

Adds a URL to the list of URIs that can be used to communicate with the Component.

Parameters:

url - the url to add

getId

public ComponentId getId()

Gets the unique ID of the Component.

Returns:

the unique ID of the Component

getType

public ComponentType getType()

Returns the ComponentType of the component.

Returns:

the ComponentType of the component

getUrls

public List<URI> getUrls()

Gets the a list of URIs that can be used to communicate with the Component.

Returns:

a list of URIs that can be used to communicate with the Component.

getUrlsForProtocol

public List<URI> getUrlsForProtocol(String... protocols)

Provides a list of URLs of a certain protocol/scheme.

Parameters:

protocols - the list of protocols to be used linked by an "or" function

Returns:

a list of URIs that can be used to communicate with the Component

setId

public void setId(ComponentId id)

Sets the unique ID of the Component.

Parameters:

id - the new unique ID of the Component

setUrls

public void setUrls(List<URI> urls)

Sets the a list of URIs that can be used to communicate with the Component.

Parameters:

urls - a list of URIs that can be used to communicate with the Component.