com.netflix.msl.io.MslEncoderFormat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of msl-core Show documentation
msl-core
There is a newer version: 1.2226.0
/**
 * Copyright (c) 2015-2017 Netflix, Inc.  All rights reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.netflix.msl.io;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * MSL encoder formats.
 * 
 * The format name is used to uniquely identify encoder formats.
 * 
 * @author Wesley Miaw 
 */
public class MslEncoderFormat {
    /** Map of names onto formats. */
    private static Map formatsByName = new HashMap();
    /** Map of identifiers onto formats. */
    private static Map formatsById = new HashMap();
    
    /** UTF-8 JSON. */
    public static final MslEncoderFormat JSON = new MslEncoderFormat("JSON", (byte)'{');
    
    /**
     * Define an encoder format with the specified name and byte stream
     * identifier.
     * 
     * @param name the encoder format name.
     * @param identifier the byte stream identifier.
     */
    protected MslEncoderFormat(final String name, final byte identifier) {
        this.name = name;
        this.identifier = identifier;
        
        // Add this format to the map.
        synchronized (formatsByName) {
            formatsByName.put(name, this);
        }
        synchronized (formatsById) {
            formatsById.put(Byte.valueOf(identifier), this);
        }
    }
    
    /**
     * @param name the encoder format name.
     * @return the encoder format identified by the specified name or
     *         {@code null} if there is none.
     */
    public static MslEncoderFormat getFormat(final String name) {
        return formatsByName.get(name);
    }
    
    /**
     * @param name the encoder format identifier.
     * @return the encoder format identified by the specified identifier or
     *         {@code null} if there is none.
     */
    public static MslEncoderFormat getFormat(final byte identifier) {
        return formatsById.get(Byte.valueOf(identifier));
    }
    
    /**
     * @return all known encoder formats.
     */
    public static Collection values() {
        return formatsByName.values();
    }
    
    /**
     * @return the format identifier.
     */
    public String name() {
        return name;
    }
    
    /**
     * @return the byte stream identifier.
     */
    public byte identifier() {
        return identifier;
    }
    
    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return name();
    }
    
    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return name.hashCode() ^ Byte.valueOf(identifier).hashCode();
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object obj) {
        if (obj == this) return true;
        if (!(obj instanceof MslEncoderFormat)) return false;
        final MslEncoderFormat that = (MslEncoderFormat)obj;
        return this.name.equals(that.name) && this.identifier == that.identifier;
    }
    
    /** Name. */
    private final String name;
    /** Byte stream identifier. */
    private final byte identifier;
}