Channel (pircbotx 2.2 API)

java.lang.Object
- org.pircbotx.Channel

All Implemented Interfaces:

Comparable<Channel>

Direct Known Subclasses:

ChannelSnapshot
```
public class Channel
extends Object
implements Comparable<Channel>
```
Represents a Channel that we're joined to.

Author:

Leon Blakey

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Channel other)` Compare `getName()` with `String.compareToIgnoreCase(java.lang.String)`.
`boolean`	`containsMode(char modeLetter)`
`ChannelSnapshot`	`createSnapshot()` Create an immutable snapshot of this channel.
`boolean`	`equals(Object o)`
`<T extends PircBotX> T`	`getBot()`
`UUID`	`getChannelId()` Unique UUID for this channel instance
`String`	`getChannelKey()` Channel key (+k)
`int`	`getChannelLimit()` Channel limit (+l #)
`long`	`getCreateTimestamp()` Timestamp of when channel was created.
`com.google.common.collect.ImmutableSortedSet<User>`	`getHalfOps()` Get all users with Half Operator status in this channel.
`String`	`getMode()` Gets the channel mode.
`String`	`getName()` The name of the channel.
`com.google.common.collect.ImmutableSortedSet<User>`	`getNormalUsers()` Get all users that don't have any special status in this channel.
`com.google.common.collect.ImmutableSortedSet<User>`	`getOps()` Get all opped users in this channel.
`com.google.common.collect.ImmutableSortedSet<User>`	`getOwners()` Get all users with Owner status in this channel.
`com.google.common.collect.ImmutableSortedSet<User>`	`getSuperOps()` Get all users with Super Operator status in this channel.
`String`	`getTopic()` The current channel topic
`UserHostmask`	`getTopicSetter()` Get the user that set the topic.
`long`	`getTopicTimestamp()` Timestamp of when the topic was created.
`com.google.common.collect.ImmutableSortedSet<UserLevel>`	`getUserLevels(User user)` Get all levels the user holds in this channel.
`com.google.common.collect.ImmutableSortedSet<User>`	`getUsers()` Get all users in this channel.
`com.google.common.collect.ImmutableSortedSet<String>`	`getUsersNicks()` Get all the user's nicks in this channel
`com.google.common.collect.ImmutableSortedSet<User>`	`getVoices()` Get all voiced users in this channel.
`int`	`hashCode()`
`boolean`	`hasTopicProtection()` Check if the channel has topic protection (+t) set.
`boolean`	`hasVoice(User user)` Checks if the given user has Voice in this channel.
`boolean`	`isChannelPrivate()` Private (+p) status
`boolean`	`isHalfOp(User user)` Checks if the given user is a Half Operator in this channel.
`boolean`	`isInviteOnly()` Invite only (+i) status
`boolean`	`isModerated()` Moderated (+m) status
`boolean`	`isNoExternalMessages()` No external messages (+n) status
`boolean`	`isOp(User user)` Checks if the given user is an Operator in this channel
`boolean`	`isOwner(User user)` Checks if the given user is an Owner in this channel.
`boolean`	`isSecret()` Secret (+s) status
`boolean`	`isSuperOp(User user)` Checks if the given user is a Super Operator in this channel.
`OutputChannel`	`send()` Send a line to the channel.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - send
```
public OutputChannel send()
```
    Send a line to the channel.
    
    Returns:
    
    A OutputChannel for this channel
  - getMode
```
public String getMode()
```
    Gets the channel mode. If mode is simple (no arguments), this will return immediately. If its not (mode with arguments, eg channel key), then asks the server for the correct mode, waiting until it gets a response
    WARNING: Because of the last checking, a threaded listener manager like ThreadedListenerManager is required. Using a single threaded listener manager like GenericListenerManager will mean this method never returns!
    
    Returns:
    
    A known good mode, either immediately or soon.
  - containsMode
```
public boolean containsMode(char modeLetter)
```
  - hasTopicProtection
```
public boolean hasTopicProtection()
```
    Check if the channel has topic protection (+t) set.
    
    Returns:
    
    True if +t
  - getUserLevels
```
public com.google.common.collect.ImmutableSortedSet<UserLevel> getUserLevels(User user)
```
    Get all levels the user holds in this channel.
    
    Parameters:
    
    user - The user to get the levels of
    
    Returns:
    
    An immutable copy of the levels the user holds
  - getNormalUsers
```
public com.google.common.collect.ImmutableSortedSet<User> getNormalUsers()
```
    Get all users that don't have any special status in this channel. This means that they aren't ops, have voice, superops, halops, or owners in this channel
    
    Returns:
    
    An immutable copy of normal users
  - getOps
```
public com.google.common.collect.ImmutableSortedSet<User> getOps()
```
    Get all opped users in this channel.
    
    Returns:
    
    An immutable copy of opped users
  - getVoices
```
public com.google.common.collect.ImmutableSortedSet<User> getVoices()
```
    Get all voiced users in this channel.
    
    Returns:
    
    An immutable copy of voiced users
  - getOwners
```
public com.google.common.collect.ImmutableSortedSet<User> getOwners()
```
    Get all users with Owner status in this channel.
    
    Returns:
    
    An immutable copy of users with Owner status
  - getHalfOps
```
public com.google.common.collect.ImmutableSortedSet<User> getHalfOps()
```
    Get all users with Half Operator status in this channel.
    
    Returns:
    
    An immutable copy of users with Half Operator status
  - getSuperOps
```
public com.google.common.collect.ImmutableSortedSet<User> getSuperOps()
```
    Get all users with Super Operator status in this channel.
    
    Returns:
    
    An immutable copy of users with Super Operator status
  - getUsers
```
public com.google.common.collect.ImmutableSortedSet<User> getUsers()
```
    Get all users in this channel. }
    
    Returns:
    
    An Unmodifiable Set of users in this channel
  - getUsersNicks
```
public com.google.common.collect.ImmutableSortedSet<String> getUsersNicks()
```
    Get all the user's nicks in this channel
    
    Returns:
    
    An Unmodifiable Set of user's nicks as String in this channel
  - getTopicSetter
```
public UserHostmask getTopicSetter()
```
    Get the user that set the topic. As the user may or may not be in the channel return as a string
    
    Returns:
    
    The user that set the topic in String format
  - isOp
```
public boolean isOp(User user)
```
    Checks if the given user is an Operator in this channel
    
    Returns:
    
    True if the user is an Operator, false if not
  - hasVoice
```
public boolean hasVoice(User user)
```
    Checks if the given user has Voice in this channel.
    
    Returns:
    
    True if the user has Voice, false if not
  - isSuperOp
```
public boolean isSuperOp(User user)
```
    Checks if the given user is a Super Operator in this channel.
    
    Returns:
    
    True if the user is a Super Operator, false if not
  - isOwner
```
public boolean isOwner(User user)
```
    Checks if the given user is an Owner in this channel.
    
    Returns:
    
    True if the user is an Owner, false if not
  - isHalfOp
```
public boolean isHalfOp(User user)
```
    Checks if the given user is a Half Operator in this channel.
    
    Returns:
    
    True if the user is a Half Operator, false if not
  - createSnapshot
```
public ChannelSnapshot createSnapshot()
```
    Create an immutable snapshot of this channel.
    
    Returns:
    
    Immutable Channel copy minus the DAO
  - compareTo
```
public int compareTo(Channel other)
```
    Compare getName() with String.compareToIgnoreCase(java.lang.String). This is useful for sorting lists of Channel objects.
    
    Specified by:
    
    compareTo in interface Comparable<Channel>
    
    Parameters:
    
    other - Other channel to compare to
    
    Returns:
    
    the result of calling compareToIgnoreCase on channel names.
  - getBot
```
public <T extends PircBotX> T getBot()
```
  - toString
```
@Generated(value="lombok")
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
@Generated(value="lombok")
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
@Generated(value="lombok")
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getName
```
@Generated(value="lombok")
public String getName()
```
    The name of the channel. Will never change
  - getChannelId
```
@Generated(value="lombok")
public UUID getChannelId()
```
    Unique UUID for this channel instance
  - getTopic
```
@Generated(value="lombok")
public String getTopic()
```
    The current channel topic
  - getTopicTimestamp
```
@Generated(value="lombok")
public long getTopicTimestamp()
```
    Timestamp of when the topic was created. Defaults to 0
  - getCreateTimestamp
```
@Generated(value="lombok")
public long getCreateTimestamp()
```
    Timestamp of when channel was created. Defaults to 0
  - isModerated
```
@Generated(value="lombok")
public boolean isModerated()
```
    Moderated (+m) status
  - isNoExternalMessages
```
@Generated(value="lombok")
public boolean isNoExternalMessages()
```
    No external messages (+n) status
  - isInviteOnly
```
@Generated(value="lombok")
public boolean isInviteOnly()
```
    Invite only (+i) status
  - isSecret
```
@Generated(value="lombok")
public boolean isSecret()
```
    Secret (+s) status
  - isChannelPrivate
```
@Generated(value="lombok")
public boolean isChannelPrivate()
```
    Private (+p) status
  - getChannelLimit
```
@Generated(value="lombok")
public int getChannelLimit()
```
    Channel limit (+l #)
  - getChannelKey
```
@Generated(value="lombok")
public String getChannelKey()
```
    Channel key (+k)

Class Channel

Method Summary

Methods inherited from class java.lang.Object

Method Detail

send

getMode

containsMode

hasTopicProtection

getUserLevels

getNormalUsers

getOps

getVoices

getOwners

getHalfOps

getSuperOps

getUsers

getUsersNicks

getTopicSetter

isOp

hasVoice

isSuperOp

isOwner

isHalfOp

createSnapshot

compareTo

getBot

toString

equals

hashCode

getName

getChannelId

getTopic

getTopicTimestamp

getCreateTimestamp

isModerated

isNoExternalMessages

isInviteOnly

isSecret

isChannelPrivate

getChannelLimit

getChannelKey