gov.bnl.channelfinder.api

Class Channel.Builder

java.lang.Object

gov.bnl.channelfinder.api.Channel.Builder

Enclosing class:

Channel

public static class Channel.Builder
extends Object

Builder class to aid in a construction of a channel.

Author:

shroffk

Constructor Summary

Constructors

Constructor and Description
Channel.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
Channel	build() build a Channel object using this builder.
static Channel.Builder	channel(Channel channel) Create a channel builder initialized to a copy of the channel
static Channel.Builder	channel(String name) Create a channel builder for a channel with the given name
Channel.Builder	owner(String owner) Set owner for the channel to be created
Channel.Builder	with(Property.Builder property) Add property to the channel to be created
Channel.Builder	with(Tag.Builder tag) Add tag to the channel to be created
Channel.Builder	withProperties(Collection<Property.Builder> properties) Add the Collection of properties to the channel to be created
Channel.Builder	withTags(Collection<Tag.Builder> tags) Add the Collection of tags to the channel to be created

Methods inherited from class java.lang.Object

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

Constructor Detail

Channel.Builder

public Channel.Builder()

Method Detail

channel

public static Channel.Builder channel(Channel channel)

Create a channel builder initialized to a copy of the channel

Parameters:

channel - - the channel to be copied

Returns:

channel Channel.Builder with all the attributes copied from the channel.

channel

public static Channel.Builder channel(String name)

Create a channel builder for a channel with the given name

Parameters:

name - - name of the channel you are creating

Returns:

channel Channel.Builder with the channel name set to name

owner

public Channel.Builder owner(String owner)

Set owner for the channel to be created

Parameters:

owner - - string owner id

Returns:

channel Channel.Builder with owner set to owner

with

public Channel.Builder with(Tag.Builder tag)

Add tag to the channel to be created

Parameters:

tag - - tag to be added

Returns:

channel Channel.Builder with tag

withTags

public Channel.Builder withTags(Collection<Tag.Builder> tags)

Add the Collection of tags to the channel to be created

Parameters:

tags - - list of tags to be added

Returns:

channel Channel.Builder with tags

with

public Channel.Builder with(Property.Builder property)

Add property to the channel to be created

Parameters:

property - - property to be added

Returns:

channel Channel.Builder with property

withProperties

public Channel.Builder withProperties(Collection<Property.Builder> properties)

Add the Collection of properties to the channel to be created

Parameters:

properties - - list of properties to be added

Returns:

channel Channel.Builder with properties

build

public Channel build()

build a Channel object using this builder.

Returns:

a Channel