com.github.theholywaffle.teamspeak3.api.wrapper.IconFile Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamspeak3-api Show documentation

A Java 7 wrapper of the TeamSpeak 3 Server Query API.

There is a newer version: 1.3.1

package com.github.theholywaffle.teamspeak3.api.wrapper;

/*
 * #%L
 * TeamSpeak 3 Java API
 * %%
 * Copyright (C) 2016 Bert De Geyter, Roger Baumgartner
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */

import java.util.Map;

public class IconFile extends FileListEntry {

	public IconFile(Map map, int channelId, String path) {
		super(map, channelId, path);
	}

	/**
	 * Gets the icon ID corresponding to this file, or {@code -1} if the file name
	 * doesn't follow the standard format.
	 *
	 * @return this file's icon ID
	 */
	public long getIconId() {
		String fileName = getName();
		if (!fileName.matches("icon_\\d{1,10}")) return -1L; // Doesn't match standard pattern
		long id = Long.parseLong(fileName.substring("icon_".length()));
		if ((id & 0xFFFF_FFFF_0000_0000L) != 0) return -1L; // CRC32 is 32 bits, so needs to fit into an int
		return id;
	}
}