001package com.github.theholywaffle.teamspeak3.api.exception;
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 com.github.theholywaffle.teamspeak3.api.wrapper.QueryError;
030
031public class TS3CommandFailedException extends TS3Exception {
032
033        private static final long serialVersionUID = 8179203326662268882L;
034
035        private final QueryError queryError;
036
037        public TS3CommandFailedException(QueryError error, String commandName) {
038                super(buildMessage(error, commandName));
039                queryError = error;
040        }
041
042        private static String buildMessage(QueryError error, String cmdName) {
043                final StringBuilder msg = new StringBuilder();
044                msg.append("A \"").append(cmdName).append("\" command returned with a server error.\n");
045                msg.append(">> ").append(error.getMessage()).append(" (ID ").append(error.getId()).append(')');
046
047                final String extra = error.getExtraMessage();
048                if (extra != null && !extra.isEmpty()) {
049                        msg.append(": ").append(extra);
050                }
051
052                final int failedPermissionId = error.getFailedPermissionId();
053                if (failedPermissionId > 0) {
054                        msg.append(", failed permission with ID ").append(failedPermissionId);
055                }
056
057                return msg.toString();
058        }
059
060        public QueryError getError() {
061                return queryError;
062        }
063}