View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  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,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.geronimo.gshell.clp.setter;
21  
22  import org.apache.geronimo.gshell.clp.ProcessingException;
23  
24  /**
25   * Provides the basic mechanism to set values.
26   *
27   * @version $Rev: 695221 $ $Date: 2008-09-14 15:47:49 +0200 (Sun, 14 Sep 2008) $
28   */
29  public interface Setter<T>
30  {
31      /**
32       * Adds/sets a value to the property of the option bean.
33       *
34       * <p>
35       * A {@link Setter} object has an implicit knowledge about the property it's setting,
36       * and the instance of the option bean.
37       */
38      void set(T value) throws ProcessingException;
39  
40      String getName();
41      
42      /**
43       * Gets the type of the underlying method/field.
44       */
45      Class<T> getType();
46      
47      /**
48       * Whether this setter is instrinsically multi-valued.
49       */
50      boolean isMultiValued();
51  }