org.apache.dubbo.qos.command.annotation.Cmd Maven / Gradle / Ivy

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

The all in one project of dubbo

There is a newer version: 3.3.0-beta.3

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.dubbo.qos.command.annotation;

import org.apache.dubbo.qos.permission.PermissionLevel;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Command
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Cmd {

    /**
     * Command name
     *
     * @return command name
     */
    String name();

    /**
     * Command description
     *
     * @return command description
     */
    String summary();

    /**
     * Command example
     *
     * @return command example
     */
    String[] example() default {};

    /**
     * Command order in help
     *
     * @return command order in help
     */
    int sort() default 0;

    /**
     * Command required access permission level
     *
     * @return command permission level
     */
    PermissionLevel requiredPermissionLevel() default PermissionLevel.PROTECTED;

}