View Javadoc

1   package org.apache.torque.generator.option;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.torque.generator.qname.QualifiedName;
23  
24  /**
25   * An option used in the code generation process.
26   * It has got a name, a value, and a context where it belongs to.
27   */
28  public interface Option
29  {
30      /**
31       * Returns the qualified name of the option.
32       *
33       * @return the qualified name of the option, not null.
34       */
35      QualifiedName getQualifiedName();
36  
37      /**
38       * Returns the value of the option.
39       *
40       * @return the value of the option, may be null.
41       */
42      Object getValue();
43  }