com.speedment.codegen.model.Enum Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of speedment Show documentation
There is a newer version: 3.0.0-EA
/**
 *
 * Copyright (c) 2006-2016, Speedment, 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.speedment.codegen.model;

import com.speedment.annotation.Api;
import com.speedment.codegen.model.modifier.EnumModifier;
import com.speedment.codegen.model.trait.HasConstructors;
import com.speedment.internal.codegen.model.EnumImpl;
import java.util.List;
import static java.util.Objects.requireNonNull;
import java.util.function.Function;

/**
 * A model that represents an enumeration in code.
 *
 * @author Emil Forslund
 * @see EnumConstant
 * @since  2.0
 */
@Api(version = "2.3")
public interface Enum extends ClassOrInterface, EnumModifier,
    HasConstructors {

    /**
     * Adds the specified constant to this enum. The constant must not be null.
     *
     * @param constant the constant
     * @return a reference to this model
     */
    default Enum add(EnumConstant constant) {
        getConstants().add(requireNonNull(constant));
        return this;
    }

    /**
     * Returns a modifiable list of all the constants in this enum.
     *
     * @return a list of constants
     */
    List getConstants();

    /**
     * Factory holder.
     */
    enum Factory {
        INST;
        private Function mapper = EnumImpl::new;
    }

    /**
     * Creates a new instance implementing this interface by using the class
     * supplied by the default factory. To change implementation, please use the
     * {@link #setSupplier(java.util.function.Function) setSupplier} method.
     *
     * @param name the name
     * @return the new instance
     */
    static Enum of(String name) {
        return Factory.INST.mapper.apply(name);
    }

    /**
     * Sets the instantiation factory method used to create new instances of
     * this interface.
     *
     * @param mapper the new constructor
     */
    static void setSupplier(Function mapper) {
        Factory.INST.mapper = requireNonNull(mapper);
    }
}