|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServiceBuilder
Provide an interface for constructing Service objects.
Method Summary | |
---|---|
void |
addProperty(String name,
String value)
Add a Property object with the given name and value to this Service or replace an existing Property of the same name. |
ServiceBuilder |
addService(String name,
ServiceType type,
URI baseUri)
Add a new Service object with the given name, type, and base uri to this Service returning a ServiceBuilder object to allow full construction and modification of the new Service. |
Service |
build()
Return the finished Service. |
ServiceBuilder |
findServiceBuilderByNameGlobally(String name)
|
URI |
getBaseUri()
|
String |
getDescription()
|
String |
getName()
|
List<String> |
getPropertyNames()
|
String |
getPropertyValue(String name)
|
ServiceBuilder |
getServiceBuilderByName(String name)
|
List<ServiceBuilder> |
getServiceBuilders()
|
String |
getSuffix()
|
ServiceType |
getType()
|
boolean |
removeProperty(String name)
|
boolean |
removeService(ServiceBuilder serviceBuilder)
|
void |
setBaseUri(URI baseUri)
|
void |
setDescription(String description)
|
void |
setSuffix(String suffix)
|
void |
setType(ServiceType type)
|
Methods inherited from interface thredds.catalog2.builder.ThreddsBuilder |
---|
getIssues, isBuilt |
Method Detail |
---|
String getName()
String getDescription()
void setDescription(String description)
ServiceType getType()
void setType(ServiceType type)
URI getBaseUri()
void setBaseUri(URI baseUri)
String getSuffix()
void setSuffix(String suffix)
void addProperty(String name, String value)
name
- the name of the Property to be added.value
- the value of the property to be added.
IllegalArgumentException
- if the name or value are null.boolean removeProperty(String name)
List<String> getPropertyNames()
String getPropertyValue(String name)
ServiceBuilder addService(String name, ServiceType type, URI baseUri)
If this Service or an already added Service has the given name, an
IllegalStateException is thrown. getServiceBuilderByName(String)
can be used to check before calling this method.
name
- the name of the new Service object.type
- the type of the new Service object.baseUri
- the base URI of the new Service object.
IllegalArgumentException
- if the name, type, or base URI are null.
IllegalStateException
- this ServiceBuilder has already been finished or the top container of this ServiceBuilder already contains a ServiceBuilder with the given name.boolean removeService(ServiceBuilder serviceBuilder)
List<ServiceBuilder> getServiceBuilders()
ServiceBuilder getServiceBuilderByName(String name)
ServiceBuilder findServiceBuilderByNameGlobally(String name)
Service build() throws BuilderException
build
in interface ThreddsBuilder
BuilderException
- if this ThreddsBuilder is not in a valid state.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |