tech.sirwellington.alchemy.annotations.designs.patterns.BuilderPattern Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Sir Wellington.
 *
 * 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 tech.sirwellington.alchemy.annotations.designs.patterns;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.CLASS;

/**
 * Documents the application and use of the Builder Pattern.
 *
 * @see
 * http://www.oodesign.com/builder-pattern.html
 *
 * @author SirWellington
 */
@Documented
@Retention(CLASS)
@Target(TYPE)
public @interface BuilderPattern
{

    Role role();

    public static enum Role
    {

        /**
         * Applied to the Builder, responsible for configuring and creating the product, for the
         * Client.
         */
        BUILDER,
        /**
         * (optional) Applied to a concrete Builder. In some application of this pattern, the
         * Builder is an interface, and implementations are captured separately.
         */
        CONCRETE_BUILDER,
        /**
         * Applied to an Object that is created by the Builder.
         */
        PRODUCT,
        /**
         * Applied to an Object or Class that knowingly uses the Builder Pattern.
         */
        CLIENT
    }
}