jakarta.enterprise.lang.model.declarations.FieldInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.enterprise.lang-model Show documentation

Build Compatible (Reflection-Free) Java Language Model for CDI

The newest version!

/*
 * Copyright 2021, Red Hat, Inc., and individual contributors
 *
 * 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 jakarta.enterprise.lang.model.declarations;

import jakarta.enterprise.lang.model.types.Type;

/**
 * A field, {@linkplain #declaringClass() declared} in some class.
 *
 * @since 4.0
 */
public interface FieldInfo extends DeclarationInfo {
    /**
     * Returns the name of this field.
     *
     * @return the name of this field, never {@code null}
     */
    String name();

    /**
     * Returns the {@linkplain Type type} of this field.
     *
     * @return the {@linkplain Type type} of this field, never {@code null}
     */
    Type type();

    /**
     * Returns whether this field is {@code static}.
     *
     * @return whether this field is {@code static}.
     */
    boolean isStatic();

    /**
     * Returns whether this field is {@code final}.
     *
     * @return whether this field is {@code final}.
     */
    boolean isFinal();

    /**
     * Returns the modifiers of this field as an {@code int}.
     * Use {@link java.lang.reflect.Modifier Modifier} to inspect the value.
     *
     * @return the modifiers of this field
     */
    int modifiers();

    /**
     * Returns the {@linkplain ClassInfo class} that declares this field.
     *
     * @return the {@linkplain ClassInfo class} that declares this field, never {@code null}
     */
    ClassInfo declaringClass();

    // ---

    @Override
    default Kind kind() {
        return Kind.FIELD;
    }

    @Override
    default FieldInfo asField() {
        return this;
    }
}