io.rxmicro.common.meta.ReadMore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rxmicro-common Show documentation

The common module with base models and useful utils.

There is a newer version: 0.11

/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * 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 io.rxmicro.common.meta;

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

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Provides read more link with caption.
 *
 * 
 * This info is used for project documentation module!
 *
 * @author nedis
 * @since 0.1
 */
@Documented
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE, FIELD})
public @interface ReadMore {

    /**
     * Returns the caption.
     *
     * @return the caption
     */
    String caption();

    /**
     * Provides the link to get additional info.
     *
     * @return the link to get additional info
     */
    String link();
}