gov.bnl.channelfinder.api

Class Channel

java.lang.Object

gov.bnl.channelfinder.api.Channel

public class Channel
extends Object

A Channel object represents channel finder channel.
Each channel has a unique name and an owner and may have zero or more properties/tags associated with it.

Author:

shroffk

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Channel.Builder Builder class to aid in a construction of a channel.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() Returns the Name of the channel.
String	getOwner() Returns the owner of this channel.
Collection<Property>	getProperties() Returns a list of all the Propertys associated with this channel.
Property	getProperty(String propertyName) Returns the Property with the name = propertyName if present on this channel else null if no property with given name found.
Collection<String>	getPropertyNames() Returns a Collection of names of all the properties associated with this channel.
Tag	getTag(String tagName) Returns the tag with name = tagName is present on this channel else returns null
Collection<String>	getTagNames() Returns a collection of all the names of the tags present on this channel.
Collection<Tag>	getTags() Returns a list of Tags associated with this channel.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Returns the Name of the channel.

Returns:

channel name.

getOwner

public String getOwner()

Returns the owner of this channel.

Returns:

owner name.

getTags

public Collection<Tag> getTags()

Returns a list of Tags associated with this channel.

Returns:

a list of Tag or null is no properties are present.

getTag

public Tag getTag(String tagName)

Returns the tag with name = tagName is present on this channel else returns null

Parameters:

tagName - - tag name

Returns:

Tag with name=tagName else null is tag with same name not present

getTagNames

public Collection<String> getTagNames()

Returns a collection of all the names of the tags present on this channel.

Returns:

Collection of TagNames.

getProperties

public Collection<Property> getProperties()

Returns a list of all the Propertys associated with this channel.

Returns:

A list of Property or null if no properties present.

getProperty

public Property getProperty(String propertyName)

Returns the Property with the name = propertyName if present on this channel else null if no property with given name found.

Parameters:

propertyName - - name of the property

Returns:

A Property or null if property with name=propertyName not found.

getPropertyNames

public Collection<String> getPropertyNames()

Returns a Collection of names of all the properties associated with this channel.

Returns:

A Collection of propertyNames.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object