← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to schema2beans/rt/src/org/netbeans/modules/schema2beans/Wrapper.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
schema2beans/rt/src/org/netbeans/modules/schema2beans/Wrapper.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.modules.schema2beans;
 
43
 
 
44
/**
 
45
 *  The Wrapper interface is one of the two ways a user can initialize a
 
46
 *  Wrapper object.
 
47
 *
 
48
 *  By default, when schema2beans generates the java classes, a #PCDATA DTD type
 
49
 *  is mapped to a java String. Sometime, the user might want to map an
 
50
 *  element to either a scalar or a specialized type (user defined class).
 
51
 *
 
52
 *  For example, a price DTD element specified as #PCDATA could be mapped
 
53
 *  to a float or integer data type. Or a date DTD element also specified
 
54
 *  as #PCDATA could be mapped to a specialized Date object, that the user might
 
55
 *  provide. schema2beans calls these specialized object 'wrappers'.
 
56
 *
 
57
 *  If the user specifies a wrapper object in the mdd file (see user
 
58
 *  documentation for mdd explanations), schema2beans uses the wrapper class
 
59
 *  instead of the String type. In this case, schema2beans needs to initialize
 
60
 *  the wrapper object using the String value from the XML document, and
 
61
 *  also needs to be able to get the String value from the wrapper 
 
62
 *  object (in order to write back the XML document).
 
63
 *
 
64
 *  This what this Wrapper interface provides. A wrapper class has
 
65
 *  has either to have a String constructor and toString() method,
 
66
 *  or implements the Wrapper interface. This is how schema2beans can set/get
 
67
 *  the String values of user wrapper/customized object.
 
68
 *
 
69
 */
 
70
public interface Wrapper {
 
71
    /**
 
72
     *  Method called by the schema2beans runtime to get the String value of the
 
73
     *  wrapper object. This String value is the value that has to appear 
 
74
     *  in the XML document.
 
75
     */
 
76
    public String       getWrapperValue();
 
77
    
 
78
    /**
 
79
     *  Method called by the schema2beans runtime to set the value of the
 
80
     *  wrapper object. The String value is the value read in the XML document.
 
81
     */
 
82
    public void         setWrapperValue(String value);
 
83
}