Source Code Cross Referenced for Transducer.java in  » 6.0-JDK-Modules » jaxb-impl » com » sun » xml » bind » v2 » runtime » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » jaxb impl » com.sun.xml.bind.v2.runtime 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        /*
002:         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003:         * 
004:         * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005:         * 
006:         * The contents of this file are subject to the terms of either the GNU
007:         * General Public License Version 2 only ("GPL") or the Common Development
008:         * and Distribution License("CDDL") (collectively, the "License").  You
009:         * may not use this file except in compliance with the License. You can obtain
010:         * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011:         * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
012:         * language governing permissions and limitations under the License.
013:         * 
014:         * When distributing the software, include this License Header Notice in each
015:         * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016:         * Sun designates this particular file as subject to the "Classpath" exception
017:         * as provided by Sun in the GPL Version 2 section of the License file that
018:         * accompanied this code.  If applicable, add the following below the License
019:         * Header, with the fields enclosed by brackets [] replaced by your own
020:         * identifying information: "Portions Copyrighted [year]
021:         * [name of copyright owner]"
022:         * 
023:         * Contributor(s):
024:         * 
025:         * If you wish your version of this file to be governed by only the CDDL or
026:         * only the GPL Version 2, indicate your decision by adding "[Contributor]
027:         * elects to include this software in this distribution under the [CDDL or GPL
028:         * Version 2] license."  If you don't indicate a single choice of license, a
029:         * recipient has the option to distribute your version of this file under
030:         * either the CDDL, the GPL Version 2 or to extend the choice of license to
031:         * its licensees as provided above.  However, if you add GPL Version 2 code
032:         * and therefore, elected the GPL Version 2 license, then the option applies
033:         * only if the new code is made subject to such option by the copyright
034:         * holder.
035:         */
036:
037:        package com.sun.xml.bind.v2.runtime;
038:
039:        import java.io.IOException;
040:
041:        import javax.xml.bind.annotation.XmlValue;
042:        import javax.xml.datatype.XMLGregorianCalendar;
043:        import javax.xml.namespace.QName;
044:        import javax.xml.stream.XMLStreamException;
045:
046:        import com.sun.istack.NotNull;
047:        import com.sun.xml.bind.api.AccessorException;
048:        import com.sun.xml.bind.v2.model.runtime.RuntimePropertyInfo;
049:        import com.sun.xml.bind.v2.runtime.reflect.opt.OptimizedTransducedAccessorFactory;
050:
051:        import org.xml.sax.SAXException;
052:
053:        /**
054:         * Responsible for converting a Java object to a lexical representation
055:         * and vice versa.
056:         *
057:         * <p>
058:         * An implementation of this interface hides how this conversion happens.
059:         *
060:         * <p>
061:         * {@link Transducer}s are immutable.
062:         *
063:         * @author Kohsuke Kawaguchi (kk@kohsuke.org)
064:         */
065:        public interface Transducer<ValueT> {
066:
067:            /**
068:             * If this {@link Transducer} is the default transducer for the <code>ValueT</code>,
069:             * this method returns true.
070:             *
071:             * Used exclusively by {@link OptimizedTransducedAccessorFactory#get(RuntimePropertyInfo)}
072:             */
073:            boolean isDefault();
074:
075:            /**
076:             * If true, this {@link Transducer} doesn't declare any namespace,
077:             * and therefore {@link #declareNamespace(Object, XMLSerializer)} is no-op.
078:             *
079:             * It also means that the {@link #parse(CharSequence)} method
080:             * won't use the context parameter.
081:             */
082:            boolean useNamespace();
083:
084:            /**
085:             * Declares the namespace URIs used in the given value to {@code w}.
086:             *
087:             * @param o
088:             *      never be null.
089:             * @param w
090:             *      may be null if {@code !{@link #useNamespace()}}.
091:             */
092:            void declareNamespace(ValueT o, XMLSerializer w)
093:                    throws AccessorException;
094:
095:            /**
096:             * Converts the given value to its lexical representation.
097:             *
098:             * @param o
099:             *      never be null.
100:             * @return
101:             *      always non-null valid lexical representation.
102:             */
103:            @NotNull
104:            CharSequence print(@NotNull
105:            ValueT o) throws AccessorException;
106:
107:            /**
108:             * Converts the lexical representation to a value object.
109:             *
110:             * @param lexical
111:             *      never be null.
112:             * @throws AccessorException
113:             *      if the transducer is used to parse an user bean that uses {@link XmlValue},
114:             *      then this exception may occur when it tries to set the leaf value to the bean.
115:             * @throws SAXException
116:             *      if the lexical form is incorrect, the error should be reported
117:             *      and SAXException may thrown (or it can return null to recover.)
118:             */
119:            ValueT parse(CharSequence lexical) throws AccessorException,
120:                    SAXException;
121:
122:            /**
123:             * Sends the result of the {@link #print(Object)} operation
124:             * to one of the {@link XMLSerializer#text(String, String)} method,
125:             * but with the best representation of the value, not necessarily String.
126:             */
127:            void writeText(XMLSerializer w, ValueT o, String fieldName)
128:                    throws IOException, SAXException, XMLStreamException,
129:                    AccessorException;
130:
131:            /**
132:             * Sends the result of the {@link #print(Object)} operation
133:             * to one of the {@link XMLSerializer#leafElement(Name, String, String)} method.
134:             * but with the best representation of the value, not necessarily String.
135:             */
136:            void writeLeafElement(XMLSerializer w, Name tagName, @NotNull
137:            ValueT o, String fieldName) throws IOException, SAXException,
138:                    XMLStreamException, AccessorException;
139:
140:            /**
141:             * Transducers implicitly work against a single XML type,
142:             * but sometimes (most notably {@link XMLGregorianCalendar},
143:             * an instance may choose different XML types.
144:             *
145:             * @return
146:             *      return non-null from this method allows transducers
147:             *      to specify the type it wants to marshal to.
148:             *      Most of the time this method returns null, in which case
149:             *      the implicitly associated type will be used.
150:             */
151:            QName getTypeName(@NotNull
152:            ValueT instance);
153:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.