001package com.github.theholywaffle.teamspeak3.api.wrapper;
002
003/*
004 * #%L
005 * TeamSpeak 3 Java API
006 * %%
007 * Copyright (C) 2014 Bert De Geyter
008 * %%
009 * Permission is hereby granted, free of charge, to any person obtaining a copy
010 * of this software and associated documentation files (the "Software"), to deal
011 * in the Software without restriction, including without limitation the rights
012 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
013 * copies of the Software, and to permit persons to whom the Software is
014 * furnished to do so, subject to the following conditions:
015 * 
016 * The above copyright notice and this permission notice shall be included in
017 * all copies or substantial portions of the Software.
018 * 
019 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
020 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
021 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
022 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
023 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
024 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
025 * THE SOFTWARE.
026 * #L%
027 */
028
029import java.util.Map;
030
031import com.github.theholywaffle.teamspeak3.api.ChannelProperty;
032
033public class Channel extends ChannelBase {
034
035        public Channel(Map<String, String> map) {
036                super(map);
037        }
038
039        @Override
040        public int getId() {
041                return getInt(ChannelProperty.CID);
042        }
043
044        public int getTotalClientsFamily() {
045                return getInt("total_clients_family");
046        }
047
048        public int getTotalClients() {
049                return getInt("total_clients");
050        }
051
052        public int getNeededSubscribePower() {
053                return getInt(ChannelProperty.CHANNEL_NEEDED_SUBSCRIBE_POWER);
054        }
055
056        /**
057         * @return {@code true}, if the channel is empty, {@code false} otherwise.
058         */
059        public boolean isEmpty() {
060                return (getTotalClients() == 0);
061        }
062
063        @Override
064        public boolean isFamilyEmpty() {
065                return (getTotalClientsFamily() == 0);
066        }
067}