org.schwering.irc.lib.util.CTCPCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of irclib Show documentation

A Java Internet Relay Chat library

The newest version!

/**
 * IRClib - A Java Internet Relay Chat library
 * Copyright (C) 2006-2015 Christoph Schwering 
 * and/or other contributors as indicated by the @author tags.
 *
 * This library and the accompanying materials are made available under the
 * terms of the
 *  - GNU Lesser General Public License,
 *  - Apache License, Version 2.0 and
 *  - Eclipse Public License v1.0.
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY.
 */
package org.schwering.irc.lib.util;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * An enum of Client-to-client protocol (CTCP) commands.
 * See http://www.irchelp.org/irchelp/rfc/ctcpspec.html
 *
 * @author Peter Palaga
 */
public enum CTCPCommand {
    ACTION,
    DCC,
    SED,
    FINGER,
    VERSION,
    SOURCE,
    USERINFO,
    CLIENTINFO,
    ERRMSG,
    PING,
    TIME;

    private static final Map FAST_LOOKUP;
    public static final int SHORTEST_COMMAND_LENGTH;
    public static final char QUOTE_CHAR = '\u0001';
    static {
        int shortestLength = Integer.MAX_VALUE;
        Map fastLookUp = new HashMap(64);
        CTCPCommand[] values = values();
        for (CTCPCommand value : values) {
            String name = value.name();
            int len = name.length();
            if (shortestLength > len) {
                shortestLength = len;
            }
            fastLookUp.put(name, value);
        }
        FAST_LOOKUP = Collections.unmodifiableMap(fastLookUp);
        SHORTEST_COMMAND_LENGTH = shortestLength;
    }

    /**
     * A {@link HashMap}-backed and {@code null}-tolerant alternative to
     * {@link #valueOf(String)}. The lookup is case-sensitive.
     *
     * @param command
     *            the command as a {@link String}
     * @return the {@link CTCPCommand} that corresponds to the given string
     *         {@code command} or {@code null} if no such command exists
     */
    public static CTCPCommand fastValueOf(String command) {
        return FAST_LOOKUP.get(command);
    }
}