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  package org.apache.commons.jxpath;
18  
19  import java.io.Serializable;
20  
21  /**
22   * A Container is an object implementing an indirection
23   * mechanism transparent to JXPath.  For example, if property
24   * "foo" of the context node has a Container as its value,
25   * the XPath "foo" will produce the contents of that Container,
26   * rather than the container itself.
27   *
28   * @author Dmitri Plotnikov
29   * @version $Revision: 652925 $ $Date: 2008-05-02 18:05:41 -0400 (Fri, 02 May 2008) $
30   */
31  public interface Container extends Serializable {
32  
33      /**
34       * Returns the contained value.
35       * @return Object value
36       */
37      Object getValue();
38  
39      /**
40       * Modifies the value contained by this container.  May throw
41       * UnsupportedOperationException.
42       * @param value Object value to set.
43       */
44      void setValue(Object value);
45  }