TokenInstance.java

/*
 * Copyright 2009 James Abley
 * 
 * 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.eternus.ratelimit;

/**
 * {@link Token} is defined as an interface in case future clients need to extend it.
 * 
 * @author jabley
 * 
 */
public enum TokenInstance implements Token {

    /**
     * The usable instance of {@link Token}.
     */
    USABLE() {

        /**
         * {@inheritDoc}
         */
        public boolean isUsable() {
            return true;
        }
    },

    /**
     * The unusable instance of {@link Token}.
     */
    UNUSABLE() {

        /**
         * {@inheritDoc}
         */
        public boolean isUsable() {
            return false;
        }
    };

}