package act.cli; /*- * #%L * ACT Framework * %% * Copyright (C) 2014 - 2017 ActFramework * %% * 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. * #L% */ import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * Indicate a command argument is mandatory */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.PARAMETER, ElementType.FIELD}) public @interface Required { /** * Specify the argument lead, e.g. *

     *     {@literal @}Command("account.show")
     *     public Account showAccount({@literal @}Required({"-i", "--id"}) String id) {
     *          return Account.findById(id);
     *     }
     * 

     *     {@literal @}Command("account.show")
     *     public Account showAccount({@literal @}Required("-i,--id") String id) {
     *          return Account.findById(id);
     *     }
     * 

If not specified, then the system will assume the argument lead to be follows

*
• {@code -o}, where "o" is the first char of the argument name
*
• {@code --option}, where "option" is the full argument name
*