/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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 io.micronaut.inject.ast;

import org.jetbrains.annotations.NotNull;

import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Optional;

A property element represents a JavaBean property on a ClassElement. 
Author:
graemerocher
Since:
1.0/**
 * A property element represents a JavaBean property on a {@link ClassElement}.
 *
 * @author graemerocher
 * @since 1.0
 */
public interface PropertyElement extends TypedElement, MemberElement {
    
Returns:
The type of the property/**
     * @return The type of the property
     */
    @NotNull
    @NonNull
    @Override
    ClassElement getType();

    
Return true only if the property has a getter but no setter.
Returns:
True if the property is read only./**
     * Return true only if the property has a getter but no setter.
     *
     * @return True if the property is read only.
     */
    default boolean isReadOnly() {
        return !getWriteMethod().isPresent();
    }

    
Returns:
The name of the method used to write the property/**
     * @return The name of the method used to write the property
     */
    default Optional<MethodElement> getWriteMethod() {
        return Optional.empty();
    }

    
Returns:
The name of the method used to read the property/**
     * @return The name of the method used to read the property
     */
    default Optional<MethodElement> getReadMethod() {
        return Optional.empty();
    }
}