001/*
002 * BridJ - Dynamic and blazing-fast native interop for Java.
003 * http://bridj.googlecode.com/
004 *
005 * Copyright (c) 2010-2013, Olivier Chafik (http://ochafik.com/)
006 * All rights reserved.
007 *
008 * Redistribution and use in source and binary forms, with or without
009 * modification, are permitted provided that the following conditions are met:
010 * 
011 *     * Redistributions of source code must retain the above copyright
012 *       notice, this list of conditions and the following disclaimer.
013 *     * Redistributions in binary form must reproduce the above copyright
014 *       notice, this list of conditions and the following disclaimer in the
015 *       documentation and/or other materials provided with the distribution.
016 *     * Neither the name of Olivier Chafik nor the
017 *       names of its contributors may be used to endorse or promote products
018 *       derived from this software without specific prior written permission.
019 * 
020 * THIS SOFTWARE IS PROVIDED BY OLIVIER CHAFIK AND CONTRIBUTORS ``AS IS'' AND ANY
021 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
024 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030 */
031package org.bridj;
032
033import java.util.Collections;
034import java.util.Iterator;
035
036/**
037 * Interface for Java enumerations that have an integral value associated
038 *
039 * @author ochafik
040 * @param <E> type of the enum
041 */
042public interface ValuedEnum<E extends Enum<E>> extends Iterable<E> {
043
044    long value();
045//
046//    public static class EnumWrapper<EE extends Enum<EE>> implements ValuedEnum<EE> {
047//        EE enumValue;
048//        public EnumWrapper(EE enumValue) {
049//            if (enumValue == null)
050//                throw new IllegalArgumentException("Null enum value !");
051//            this.enumValue = enumValue;
052//        }
053//
054//        @Override
055//        public long value() {
056//            return enumValue.ordinal();
057//        }
058//
059//        @Override
060//        public Iterator<EE> iterator() {
061//            return Collections.singleton(enumValue).iterator();
062//        }
063//
064//    }
065//
066//    public enum MyEnum implements ValuedEnum<MyEnum> {
067//        A(1), B(2);
068//
069//        MyEnum(long value) { this.value = value; }
070//        long value;
071//        @Override
072//        public long value() {
073//            return ordinal();
074//        }
075//
076//        @Override
077//        public Iterator<MyEnum> iterator() {
078//            return Collections.singleton(this).iterator();
079//        }
080//
081//        public static ValuedEnum<MyEnum> fromValue(long value) {
082//            return FlagSet.fromValue(value, values());
083//        }
084//    }
085}