org.jclouds.ultradns.ws.ResourceTypeToValue.java Source code

Introduction

Here is the source code for org.jclouds.ultradns.ws.ResourceTypeToValue.java

Source

/**
 * Licensed to jclouds, Inc. (jclouds) under one or more
 * contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  jclouds licenses this file
 * to you 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 org.jclouds.ultradns.ws;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

import java.util.EnumSet;
import java.util.Set;

import com.google.common.annotations.Beta;
import com.google.common.base.Function;
import com.google.common.collect.BiMap;
import com.google.common.collect.ForwardingMap;
import com.google.common.collect.ImmutableBiMap;
import com.google.common.primitives.UnsignedInteger;

/**
 * Most UltraDNS commands use the numerical type value of a resource record
 * rather than their names. This class helps convert the numerical values to
 * what people more commonly use. Note that this does not complain a complete
 * mapping and may need updates over time.
 * 
 * @author Adrian Cole
 * @see org.jclouds.rest.annotations.ParamParser
 */
@Beta
public class ResourceTypeToValue extends ForwardingMap<String, UnsignedInteger>
        implements Function<Object, String>, BiMap<String, UnsignedInteger> {

    /**
     * look up the value (ex. {@code 28}) for the mnemonic name (ex. {@code AAAA}
     * ).
     * 
     * @param type
     *           type to look up. ex {@code AAAA}
     * @throws IllegalArgumentException
     *            if the type was not configured.
     */
    public static UnsignedInteger lookup(String type) throws IllegalArgumentException {
        checkNotNull(type, "resource type was null");
        checkArgument(lookup.containsKey(type), "%s do not include %s; types: %s",
                ResourceTypes.class.getSimpleName(), type, EnumSet.allOf(ResourceTypes.class));
        return lookup.get(type);
    }

    /**
     * Taken from <a href=
     * "http://www.iana.org/assignments/dns-parameters/dns-parameters.xml#dns-parameters-3"
     * >iana types</a>.
     * 
     */
    // enum only to look and format prettier than fluent bimap builder calls
    private static enum ResourceTypes {
        /**
         * a host address
         */
        A(1),

        /**
         * an authoritative name server
         */
        NS(2),

        /**
         * the canonical name for an alias
         */
        CNAME(5),

        /**
         * marks the start of a zone of authority
         */
        SOA(6),

        /**
         * a domain name pointer
         */
        PTR(12),

        /**
         * mail exchange
         */
        MX(15),

        /**
         * text strings
         */
        TXT(16),

        /**
         * IP6 Address
         */
        AAAA(28),

        /**
         * Server Selection
         */
        SRV(33);

        private final UnsignedInteger value;

        private ResourceTypes(int value) {
            this.value = UnsignedInteger.fromIntBits(value);
        }
    }

    @Override
    protected ImmutableBiMap<String, UnsignedInteger> delegate() {
        return lookup;
    }

    private static final ImmutableBiMap<String, UnsignedInteger> lookup;

    static {
        ImmutableBiMap.Builder<String, UnsignedInteger> builder = ImmutableBiMap.builder();
        for (ResourceTypes r : EnumSet.allOf(ResourceTypes.class)) {
            builder.put(r.name(), r.value);
        }
        lookup = builder.build();
    }

    /**
     * @see ImmutableBiMap#forcePut(Object, Object)
     */
    @Deprecated
    @Override
    public UnsignedInteger forcePut(String key, UnsignedInteger value) {
        return lookup.forcePut(key, value);
    }

    @Override
    public Set<UnsignedInteger> values() {
        return lookup.values();
    }

    @Override
    public BiMap<UnsignedInteger, String> inverse() {
        return lookup.inverse();
    }

    @Override
    public String apply(Object input) {
        return lookup(checkNotNull(input, "resource type was null").toString()).toString();
    }
}