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.commons.betwixt.io;
19  
20  import org.apache.commons.betwixt.ElementDescriptor;
21  
22  /**
23   * <p>Context against which content should be written.</p>
24   * <p>
25   * <strong>Usage:</strong>
26   * This (logical) interface is a <em>Parameter Object</em>
27   * allowing additional, <code>Betwixt</code>-specific information
28   * to be passed through the SAX-inspired writing API.
29   * </p> 
30   * <p>
31   * It is likely that access will be required to methods in the
32   * <code>Context</code> used by the {@link AbstractBeanWriter}
33   * but it seems better to add these as neccessary using delegation
34   * rather than extending {@link org.apache.commons.betwixt.expression.Context}.
35   * </p>
36   * @author <a href='http://commons.apache.org/'>Apache Commons Team</a>
37   * @since 0.5
38   */
39  public abstract class WriteContext {
40      
41      /**
42       * Gets the descriptor for the element who content 
43       * is currently being created. 
44       * 
45       * @return the <code>ElementDescriptor</code> for the 
46       * current element (or null if there is no current element) 
47       */
48      public abstract ElementDescriptor getCurrentDescriptor();
49      
50  }