io.micronaut.core.naming.Described Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-core Show documentation

Core components supporting the Micronaut Framework

There is a newer version: 4.7.12

/*
 * 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.core.naming;

import io.micronaut.core.annotation.NonNull;

/**
 * An interface for types that are described by a description.
 *
 * @author graemerocher
 * @since 1.0
 */
public interface Described {

    /**
     * A description that describes this object.
     *
     * @return The description
     */
    @NonNull String getDescription();

    /**
     * Allows returning a more simple description if requested.
     *
     * @param simple True if a simple description is required
     * @return The simple description
     */
    default @NonNull String getDescription(boolean simple) {
        return getDescription();
    }
}