com.speedment.common.codegen.model.InterfaceField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of codegen Show documentation

An object-oriented code generator for Java that is built using the Model-View-Controller (MVC) design philosophy.

There is a newer version: 3.2.10

/**
 *
 * Copyright (c) 2006-2019, 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.common.codegen.model;

import com.speedment.common.codegen.internal.model.InterfaceFieldImpl;
import com.speedment.common.codegen.model.modifier.InterfaceFieldModifier;
import com.speedment.common.codegen.model.trait.*;

/**
 * A model that represents a field of an interface in code.
 * 
 * @author  Emil Forslund
 * @see     Interface
 * @since  2.0
 */
public interface InterfaceField
extends HasParent,
        HasImports,
        HasName,
        HasType,
        InterfaceFieldModifier,
        HasJavadoc,
        HasValue,
        HasAnnotationUsage,
        HasCopy {

    /**
     * Creates a new instance implementing this interface by wrapping an existing
     * {@link Field} in an {@link InterfaceFieldImpl}.
     * 
     * @param wrapped  the wrapped field
     * @return         the new instance
     */
    static InterfaceField of(Field wrapped) {
        return new InterfaceFieldImpl(wrapped);
    }
}