1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
/* * Copyright 2003 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.xml.bind; /** * <p> * The DatatypeConverterInterface is for JAXB provider use only. A * JAXB provider must supply a class that implements this interface. * JAXB Providers are required to call the * {@link DatatypeConverter#setDatatypeConverter(DatatypeConverterInterface) * DatatypeConverter.setDatatypeConverter} api at * some point before the first marshal or unmarshal operation (perhaps during * the call to JAXBContext.newInstance). This step is necessary to configure * the converter that should be used to perform the print and parse * functionality. Calling this api repeatedly will have no effect - the * DatatypeConverter instance passed into the first invocation is the one that * will be used from then on. * </p> * * <p> * This interface defines the parse and print methods. There is one * parse and print method for each XML schema datatype specified in the * the default binding Table 5-1 in the JAXB specification. * </p> * * <p> * The parse and print methods defined here are invoked by the static parse * and print methods defined in the {@link DatatypeConverter DatatypeConverter} * class. * </p> * * <p> * A parse method for a XML schema datatype must be capable of converting any * lexical representation of the XML schema datatype ( specified by the * <a href="http://www.w3.org/TR/xmlschema-2/"> XML Schema Part2: Datatypes * specification</a> into a value in the value space of the XML schema datatype. * If an error is encountered during conversion, then an IllegalArgumentException * or a subclass of IllegalArgumentException must be thrown by the method. * * </p> * * <p> * A print method for a XML schema datatype can output any lexical * representation that is valid with respect to the XML schema datatype. * If an error is encountered during conversion, then an IllegalArgumentException, * or a subclass of IllegalArgumentException must be thrown by the method. * </p> * * The prefix xsd: is used to refer to XML schema datatypes * <a href="http://www.w3.org/TR/xmlschema-2/"> XML Schema Part2: Datatypes * specification.</a> * * <p> * @author <ul><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems Inc.</li><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Ryan Shoemaker,Sun Microsystems Inc.</li></ul> * @version $Revision: 1.4 $ * @see DatatypeConverter * @see ParseConversionEvent * @see PrintConversionEvent * @since JAXB1.0 */ public interface DatatypeConverterInterface { /** * <p> * Convert the string argument into a string. * @param lexicalXSDString * A lexical representation of the XML Schema datatype xsd:string * @return * A string that is the same as the input string. */ public String parseString( String lexicalXSDString ); /** * <p> * Convert the string argument into a BigInteger value. * @param lexicalXSDInteger * A string containing a lexical representation of * xsd:integer. * @return * A BigInteger value represented by the string argument. * @throws NumberFormatException <code>lexicalXSDInteger</code> is not a valid string representation of a {@link java.math.BigInteger} value. */ public java.math.BigInteger parseInteger( String lexicalXSDInteger ); /** * <p> * Convert the string argument into an int value. * @param lexicalXSDInt * A string containing a lexical representation of * xsd:int. * @return * An int value represented byte the string argument. * @throws NumberFormatException <code>lexicalXSDInt</code> is not a valid string representation of an <code>int</code> value. */ public int parseInt( String lexicalXSDInt ); /** * <p> * Converts the string argument into a long value. * @param lexicalXSDLong * A string containing lexical representation of * xsd:long. * @return * A long value represented by the string argument. * @throws NumberFormatException <code>lexicalXSDLong</code> is not a valid string representation of a <code>long</code> value. */ public long parseLong( String lexicalXSDLong ); /** * <p> * Converts the string argument into a short value. * @param lexicalXSDShort * A string containing lexical representation of * xsd:short. * @return * A short value represented by the string argument. * @throws NumberFormatException <code>lexicalXSDShort</code> is not a valid string representation of a <code>short</code> value. */ public short parseShort( String lexicalXSDShort ); /** * <p> * Converts the string argument into a BigDecimal value. * @param lexicalXSDDecimal * A string containing lexical representation of * xsd:decimal. * @return * A BigDecimal value represented by the string argument. * @throws NumberFormatException <code>lexicalXSDDecimal</code> is not a valid string representation of {@link java.math.BigDecimal}. */ public java.math.BigDecimal parseDecimal( String lexicalXSDDecimal ); /** * <p> * Converts the string argument into a float value. * @param lexicalXSDFloat * A string containing lexical representation of * xsd:float. * @return * A float value represented by the string argument. * @throws NumberFormatException <code>lexicalXSDFloat</code> is not a valid string representation of a <code>float</code> value. */ public float parseFloat( String lexicalXSDFloat ); /** * <p> * Converts the string argument into a double value. * @param lexicalXSDDouble * A string containing lexical representation of * xsd:double. * @return * A double value represented by the string argument. * @throws NumberFormatException <code>lexicalXSDDouble</code> is not a valid string representation of a <code>double</code> value. */ public double parseDouble( String lexicalXSDDouble ); /** * <p> * Converts the string argument into a boolean value. * @param lexicalXSDBoolean * A string containing lexical representation of * xsd:boolean. * @return * A boolean value represented by the string argument. * @throws IllegalArgumentException if string parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for xsd:boolean. */ public boolean parseBoolean( String lexicalXSDBoolean ); /** * <p> * Converts the string argument into a byte value. * @param lexicalXSDByte * A string containing lexical representation of * xsd:byte. * @return * A byte value represented by the string argument. * @throws NumberFormatException <code>lexicalXSDByte</code> does not contain a parseable byte. * @throws IllegalArgumentException if string parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for xsd:byte. */ public byte parseByte( String lexicalXSDByte ); /** * <p> * Converts the string argument into a QName value. * * <p> * String parameter <tt>lexicalXSDQname</tt> must conform to lexical value space specifed at * <a href="http://www.w3.org/TR/xmlschema-2/#QName">XML Schema Part 2:Datatypes specification:QNames</a> * * @param lexicalXSDQName * A string containing lexical representation of xsd:QName. * @param nsc * A namespace context for interpreting a prefix within a QName. * @return * A QName value represented by the string argument. * @throws IllegalArgumentException if string parameter does not conform to XML Schema Part 2 specification or * if namespace prefix of <tt>lexicalXSDQname</tt> is not bound to a URI in NamespaceContext <tt>nsc</tt>. */ public javax.xml.namespace.QName parseQName( String lexicalXSDQName, javax.xml.namespace.NamespaceContext nsc); /** * <p> * Converts the string argument into a Calendar value. * @param lexicalXSDDateTime * A string containing lexical representation of * xsd:datetime. * @return * A Calendar object represented by the string argument. * @throws IllegalArgumentException if string parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for xsd:dateTime. */ public java.util.Calendar parseDateTime( String lexicalXSDDateTime ); /** * <p> * Converts the string argument into an array of bytes. * @param lexicalXSDBase64Binary * A string containing lexical representation * of xsd:base64Binary. * @return * An array of bytes represented by the string argument. * @throws IllegalArgumentException if string parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for xsd:base64Binary */ public byte[] parseBase64Binary( String lexicalXSDBase64Binary ); /** * <p> * Converts the string argument into an array of bytes. * @param lexicalXSDHexBinary * A string containing lexical representation of * xsd:hexBinary. * @return * An array of bytes represented by the string argument. * @throws IllegalArgumentException if string parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for xsd:hexBinary. */ public byte[] parseHexBinary( String lexicalXSDHexBinary ); /** * <p> * Converts the string argument into a long value. * @param lexicalXSDUnsignedInt * A string containing lexical representation * of xsd:unsignedInt. * @return * A long value represented by the string argument. * @throws NumberFormatException if string parameter can not be parsed into a <tt>long</tt> value. */ public long parseUnsignedInt( String lexicalXSDUnsignedInt ); /** * <p> * Converts the string argument into an int value. * @param lexicalXSDUnsignedShort * A string containing lexical * representation of xsd:unsignedShort. * @return * An int value represented by the string argument. * @throws NumberFormatException if string parameter can not be parsed into an <tt>int</tt> value. */ public int parseUnsignedShort( String lexicalXSDUnsignedShort ); /** * <p> * Converts the string argument into a Calendar value. * @param lexicalXSDTime * A string containing lexical representation of * xsd:Time. * @return * A Calendar value represented by the string argument. * @throws IllegalArgumentException if string parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for xsd:Time. */ public java.util.Calendar parseTime( String lexicalXSDTime ); /** * <p> * Converts the string argument into a Calendar value. * @param lexicalXSDDate * A string containing lexical representation of * xsd:Date. * @return * A Calendar value represented by the string argument. * @throws IllegalArgumentException if string parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for xsd:Date. */ public java.util.Calendar parseDate( String lexicalXSDDate ); /** * <p> * Return a string containing the lexical representation of the * simple type. * @param lexicalXSDAnySimpleType * A string containing lexical * representation of the simple type. * @return * A string containing the lexical representation of the * simple type. */ public String parseAnySimpleType( String lexicalXSDAnySimpleType ); /** * <p> * Converts the string argument into a string. * @param val * A string value. * @return * A string containing a lexical representation of xsd:string */ public String printString( String val ); /** * <p> * Converts a BigInteger value into a string. * @param val * A BigInteger value * @return * A string containing a lexical representation of xsd:integer * @throws IllegalArgumentException <tt>val</tt> is null. */ public String printInteger( java.math.BigInteger val ); /** * <p> * Converts an int value into a string. * @param val * An int value * @return * A string containing a lexical representation of xsd:int */ public String printInt( int val ); /** * <p> * Converts a long value into a string. * @param val * A long value * @return * A string containing a lexical representation of xsd:long */ public String printLong( long val ); /** * <p> * Converts a short value into a string. * @param val * A short value * @return * A string containing a lexical representation of xsd:short */ public String printShort( short val ); /** * <p> * Converts a BigDecimal value into a string. * @param val * A BigDecimal value * @return * A string containing a lexical representation of xsd:decimal * @throws IllegalArgumentException <tt>val</tt> is null. */ public String printDecimal( java.math.BigDecimal val ); /** * <p> * Converts a float value into a string. * @param val * A float value * @return * A string containing a lexical representation of xsd:float */ public String printFloat( float val ); /** * <p> * Converts a double value into a string. * @param val * A double value * @return * A string containing a lexical representation of xsd:double */ public String printDouble( double val ); /** * <p> * Converts a boolean value into a string. * @param val * A boolean value * @return * A string containing a lexical representation of xsd:boolean */ public String printBoolean( boolean val ); /** * <p> * Converts a byte value into a string. * @param val * A byte value * @return * A string containing a lexical representation of xsd:byte */ public String printByte( byte val ); /** * <p> * Converts a QName instance into a string. * @param val * A QName value * @param nsc * A namespace context for interpreting a prefix within a QName. * @return * A string containing a lexical representation of QName * @throws IllegalArgumentException if <tt>val</tt> is null or * if <tt>nsc</tt> is non-null or <tt>nsc.getPrefix(nsprefixFromVal)</tt> is null. */ public String printQName( javax.xml.namespace.QName val, javax.xml.namespace.NamespaceContext nsc ); /** * <p> * Converts a Calendar value into a string. * @param val * A Calendar value * @return * A string containing a lexical representation of xsd:dateTime * @throws IllegalArgumentException if <tt>val</tt> is null. */ public String printDateTime( java.util.Calendar val ); /** * <p> * Converts an array of bytes into a string. * @param val * an array of bytes * @return * A string containing a lexical representation of xsd:base64Binary * @throws IllegalArgumentException if <tt>val</tt> is null. */ public String printBase64Binary( byte[] val ); /** * <p> * Converts an array of bytes into a string. * @param val * an array of bytes * @return * A string containing a lexical representation of xsd:hexBinary * @throws IllegalArgumentException if <tt>val</tt> is null. */ public String printHexBinary( byte[] val ); /** * <p> * Converts a long value into a string. * @param val * A long value * @return * A string containing a lexical representation of xsd:unsignedInt */ public String printUnsignedInt( long val ); /** * <p> * Converts an int value into a string. * @param val * An int value * @return * A string containing a lexical representation of xsd:unsignedShort */ public String printUnsignedShort( int val ); /** * <p> * Converts a Calendar value into a string. * @param val * A Calendar value * @return * A string containing a lexical representation of xsd:time * @throws IllegalArgumentException if <tt>val</tt> is null. */ public String printTime( java.util.Calendar val ); /** * <p> * Converts a Calendar value into a string. * @param val * A Calendar value * @return * A string containing a lexical representation of xsd:date * @throws IllegalArgumentException if <tt>val</tt> is null. */ public String printDate( java.util.Calendar val ); /** * <p> * Converts a string value into a string. * @param val * A string value * @return * A string containing a lexical representation of xsd:AnySimpleType */ public String printAnySimpleType( String val ); }