OptionHandler xref

View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package org.apache.log4j.spi;
    19
    20
    21  /**
    22     A string based interface to configure package components.
    23
    24     @author Ceki G&uuml;lc&uuml;
    25     @author Anders Kristensen
    26     @since 0.8.1
    27   */
    28  public interface OptionHandler {
    29
    30    /**
    31       Activate the options that were previously set with calls to option
    32       setters.
    33
    34       <p>This allows to defer activiation of the options until all
    35       options have been set. This is required for components which have
    36       related options that remain ambigous until all are set.
    37
    38       <p>For example, the FileAppender has the {@link
    39       org.apache.log4j.FileAppender#setFile File} and {@link
    40       org.apache.log4j.FileAppender#setAppend Append} options both of
    41       which are ambigous until the other is also set.  */
    42    void activateOptions();
    43
    44    /**
    45       Return list of strings that the OptionHandler instance recognizes.
    46
    47       @deprecated We now use JavaBeans style getters/setters.
    48     */
    49    //  String[] getOptionStrings();
    50
    51    /**
    52       Set <code>option</code> to <code>value</code>.
    53
    54       <p>The handling of each option depends on the OptionHandler
    55       instance. Some options may become active immediately whereas
    56       other may be activated only when {@link #activateOptions} is
    57       called.
    58
    59       @deprecated We now use JavaBeans style getters/setters.
    60    */
    61    //void setOption(String option, String value);
    62  }