me.ryandw11.ultrachat.api.channels

Class ChannelBuilder

java.lang.Object

me.ryandw11.ultrachat.api.channels.ChannelBuilder

public class ChannelBuilder
extends java.lang.Object

A Builder to make a channel.

Since:

2.3.3

Author:

Ryandw11

Constructor Summary

Constructors

Constructor and Description
ChannelBuilder(java.lang.String name) The Builder to create a channel.

Method Summary

Modifier and Type	Method and Description
ChatChannel	build() Build the channel
java.lang.String	getFormat()
java.util.List<java.lang.String>	getJson()
ChannelBuilder	setAlwaysAppear(boolean alwaysAppear) Set if the channel is always appear
ChannelBuilder	setFormat(java.lang.String format)
ChannelBuilder	setJson(java.util.List<java.lang.String> json) Set the json lore.
ChannelBuilder	setName(java.lang.String name) Set the name of the channel.
ChannelBuilder	setPermission(java.lang.String permission) Set the permission for the channel.
ChannelBuilder	setPrefix(java.lang.String prefix) Set the prefix of the channel

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelBuilder

public ChannelBuilder(java.lang.String name)

The Builder to create a channel.

Parameters:

name - The name of the channel (usually lowercase)

Method Detail

setName

public ChannelBuilder setName(java.lang.String name)

Set the name of the channel.

Parameters:

name - The name. (Lowercase is standard)

Returns:

The builder

setPrefix

public ChannelBuilder setPrefix(java.lang.String prefix)

Set the prefix of the channel

Parameters:

prefix - The prefix (supports & codes)

Returns:

The builder

setPermission

public ChannelBuilder setPermission(java.lang.String permission)

Set the permission for the channel.

Parameters:

permission - The permission

Returns:

The builder.

setAlwaysAppear

public ChannelBuilder setAlwaysAppear(boolean alwaysAppear)

Set if the channel is always appear

Parameters:

alwaysAppear - If the channel should always appear.

Returns:

The builder

build

public ChatChannel build()

Build the channel

Returns:

The channel. Note: If the channel name is already used it will return the existing one.

getJson

public java.util.List<java.lang.String> getJson()

setJson

public ChannelBuilder setJson(java.util.List<java.lang.String> json)

Set the json lore.

Parameters:

json - List of lore.

getFormat

public java.lang.String getFormat()

setFormat

public ChannelBuilder setFormat(java.lang.String format)