Home | History | Annotate | Download | only in jcommander
      1 /**
      2  * Copyright (C) 2010 the original author or authors.
      3  * See the notice.md file distributed with this work for additional
      4  * information regarding copyright ownership.
      5  *
      6  * Licensed under the Apache License, Version 2.0 (the "License");
      7  * you may not use this file except in compliance with the License.
      8  * You may obtain a copy of the License at
      9  *
     10  *     http://www.apache.org/licenses/LICENSE-2.0
     11  *
     12  * Unless required by applicable law or agreed to in writing, software
     13  * distributed under the License is distributed on an "AS IS" BASIS,
     14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15  * See the License for the specific language governing permissions and
     16  * limitations under the License.
     17  */
     18 
     19 package com.beust.jcommander;
     20 
     21 import java.lang.annotation.Retention;
     22 import java.lang.annotation.Target;
     23 
     24 import static java.lang.annotation.ElementType.FIELD;
     25 
     26 /**
     27  * <p>When applied to a field all of its child fields annotated
     28  * with {@link Parameter} will be included during arguments
     29  * parsing.</p>
     30  *
     31  * <p>Mainly useful when creating complex command based CLI interfaces,
     32  * where several commands can share a set of arguments, but using
     33  * object inheritance is not enough, due to no-multiple-inheritance
     34  * restriction. Using {@link ParametersDelegate} any number of
     35  * command sets can be shared by using composition pattern.</p>
     36  *
     37  * <p>Delegations can be chained (nested).</p>
     38  *
     39  * @author rodionmoiseev
     40  */
     41 @Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
     42 @Target({ FIELD })
     43 public @interface ParametersDelegate {
     44 }
     45