Package org.opencastproject.runtimeinfo.rest

Class RestEndpointHolderData

java.lang.Object

org.opencastproject.runtimeinfo.rest.RestEndpointHolderData

public class RestEndpointHolderData
extends Object

Represents a group of endpoints.

Constructor Summary

Constructors

Constructor	Description
RestEndpointHolderData(String name, String title)

Method Summary

Modifier and Type	Method	Description
void	addEndPoint(RestEndpointData endpoint)	Add an endpoint to this holder and make sure the endpoints are sorted by their names.
protected Object	clone()	Returns a copy of this RestEndpointHolderData object.
RestEndpointHolderData	duplicate()	Returns a copy of this RestEndpointHolderData object.
List<RestEndpointData>	getEndpoints()	Gets the list of endpoints in this endpoint holder.
String	getName()	Gets the name of this endpoint holder.
String	getTitle()	Gets the title of this endpoint holder.
String	toString()	Return a string representation of this RestEndpointHolderData object.

Methods inherited from class java.lang.Object

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

Constructor Details

RestEndpointHolderData

public RestEndpointHolderData(String name,
 String title)
                       throws IllegalArgumentException

Parameters:

name - name of this endpoint holder

title - title of this endpoint holder (to be shown on the documentation page)

Throws:

IllegalArgumentException - if name is null, name is not alphanumeric or title is null

Method Details

addEndPoint

public void addEndPoint(RestEndpointData endpoint)

Add an endpoint to this holder and make sure the endpoints are sorted by their names.

Parameters:

endpoint - an endpoint to be added to this holder

toString

public String toString()

Return a string representation of this RestEndpointHolderData object.

Overrides:

toString in class Object

Returns:

a string representation of this RestEndpointHolderData object

duplicate

public RestEndpointHolderData duplicate()

Returns a copy of this RestEndpointHolderData object.

Returns:

a copy of this RestEndpointHolderData object

clone

protected Object clone()

Returns a copy of this RestEndpointHolderData object.

Overrides:

clone in class Object

Returns:

a copy of this RestEndpointHolderData object

getName

public String getName()

Gets the name of this endpoint holder.

Returns:

the name of this endpoint holder

getTitle

public String getTitle()

Gets the title of this endpoint holder.

Returns:

the title of this endpoint holder

getEndpoints

public List<RestEndpointData> getEndpoints()

Gets the list of endpoints in this endpoint holder.

Returns:

the list of endpoints in this endpoint holder