类 CastorMarshaller

字段详细资料

• DEFAULT_ENCODING

  public static final String DEFAULT_ENCODING

  已过时。
  The default encoding used for stream access: UTF-8.

  另请参阅:

  常量字段值

构造器详细资料

• CastorMarshaller

  public CastorMarshaller()

  已过时。

方法详细资料

• setEncoding

  public void setEncoding​(String encoding)

  已过时。
  Set the encoding to be used for stream access.

  另请参阅:

  DEFAULT_ENCODING

• getDefaultEncoding

  protected String getDefaultEncoding()

  已过时。
  从类复制的说明: AbstractMarshaller
  Determine the default encoding to use for marshalling or unmarshalling from a byte stream, or null if none.

  The default implementation returns null.

  覆盖:

  getDefaultEncoding 在类中 AbstractMarshaller

• setMappingLocation

  public void setMappingLocation​(Resource mappingLocation)

  已过时。
  Set the locations of the Castor XML mapping files.

• setMappingLocations

  public void setMappingLocations​(Resource... mappingLocations)

  已过时。
  Set the locations of the Castor XML mapping files.

• setTargetClass

  public void setTargetClass​(Class<?> targetClass)

  已过时。
  Set the Castor target class.

  另请参阅:

  setTargetPackage(java.lang.String), setMappingLocation(org.springframework.core.io.Resource)

• setTargetClasses

  public void setTargetClasses​(Class<?>... targetClasses)

  已过时。
  Set the Castor target classes.

  另请参阅:

  setTargetPackages(java.lang.String...), setMappingLocations(org.springframework.core.io.Resource...)

• setTargetPackage

  public void setTargetPackage​(String targetPackage)

  已过时。
  Set the name of a package with the Castor descriptor classes.

• setTargetPackages

  public void setTargetPackages​(String... targetPackages)

  已过时。
  Set the names of packages with the Castor descriptor classes.

• setValidating

  public void setValidating​(boolean validating)

  已过时。
  Set whether this marshaller should validate in- and outgoing documents.

  Default is false.

  另请参阅:

  Marshaller.setValidation(boolean)

• setSuppressNamespaces

  public void setSuppressNamespaces​(boolean suppressNamespaces)

  已过时。
  Sets whether this marshaller should output namespaces.

  The default is false, i.e. namespaces are written.

  另请参阅:

  Marshaller.setSuppressNamespaces(boolean)

• setSuppressXsiType

  public void setSuppressXsiType​(boolean suppressXsiType)

  已过时。
  Set whether this marshaller should output the xsi:type attribute.

  The default is false, i.e. the xsi:type is written.

  另请参阅:

  Marshaller.setSuppressXSIType(boolean)

• setMarshalAsDocument

  public void setMarshalAsDocument​(boolean marshalAsDocument)

  已过时。
  Set whether this marshaller should output the xml declaration.

  The default is true, the XML declaration will be written.

  另请参阅:

  Marshaller.setMarshalAsDocument(boolean)

• setMarshalExtendedType

  public void setMarshalExtendedType​(boolean marshalExtendedType)

  已过时。
  Set whether this marshaller should output for given type the xsi:type attribute.

  The default is true, the xsi:type attribute will be written.

  另请参阅:

  Marshaller.setMarshalExtendedType(boolean)

• setRootElement

  public void setRootElement​(String rootElement)

  已过时。
  Set the name of the root element.

  另请参阅:

  Marshaller.setRootElement(String)

• setNoNamespaceSchemaLocation

  public void setNoNamespaceSchemaLocation​(String noNamespaceSchemaLocation)

  已过时。
  Set the value of xsi:noNamespaceSchemaLocation attribute. When set, the xsi:noNamespaceSchemaLocation attribute will be written for the root element.

  另请参阅:

  Marshaller.setNoNamespaceSchemaLocation(String)

• setSchemaLocation

  public void setSchemaLocation​(String schemaLocation)

  已过时。
  Set the value of xsi:schemaLocation attribute. When set, the xsi:schemaLocation attribute will be written for the root element.

  另请参阅:

  Marshaller.setSchemaLocation(String)

• setUseXSITypeAtRoot

  public void setUseXSITypeAtRoot​(boolean useXSITypeAtRoot)

  已过时。
  Sets whether this marshaller should output the xsi:type attribute for the root element. This can be useful when the type of the element can not be simply determined from the element name.

  The default is false: The xsi:type attribute for the root element won't be written.

  另请参阅:

  Marshaller.setUseXSITypeAtRoot(boolean)

• setWhitespacePreserve

  public void setWhitespacePreserve​(boolean whitespacePreserve)

  已过时。
  Set whether the Castor Unmarshaller should preserve "ignorable" whitespace.

  Default is false.

  另请参阅:

  Unmarshaller.setWhitespacePreserve(boolean)

• setIgnoreExtraAttributes

  public void setIgnoreExtraAttributes​(boolean ignoreExtraAttributes)

  已过时。
  Set whether the Castor Unmarshaller should ignore attributes that do not match a specific field.

  Default is true: Extra attributes are ignored.

  另请参阅:

  Unmarshaller.setIgnoreExtraAttributes(boolean)

• setIgnoreExtraElements

  public void setIgnoreExtraElements​(boolean ignoreExtraElements)

  已过时。
  Set whether the Castor Unmarshaller should ignore elements that do not match a specific field.

  Default is false: Extra elements are flagged as an error.

  另请参阅:

  Unmarshaller.setIgnoreExtraElements(boolean)

• setRootObject

  public void setRootObject​(Object root)

  已过时。
  Set the expected root object for the unmarshaller, into which the source will be unmarshalled.

  另请参阅:

  Unmarshaller.setObject(Object)

• setReuseObjects

  public void setReuseObjects​(boolean reuseObjects)

  已过时。
  Set whether this unmarshaller should re-use objects. This will be only used when unmarshalling to an existing object.

  The default is false, which means that the objects won't be re-used.

  另请参阅:

  Unmarshaller.setReuseObjects(boolean)

• setClearCollections

  public void setClearCollections​(boolean clearCollections)

  已过时。
  Sets whether this unmarshaller should clear collections upon the first use.

  The default is false which means that marshaller won't clear collections.

  另请参阅:

  Unmarshaller.setClearCollections(boolean)

• setCastorProperties

  public void setCastorProperties​(Map<String,​String> castorProperties)

  已过时。
  Set Castor-specific properties for marshalling and unmarshalling. Each entry key is considered the property name and each value the property value.

  另请参阅:

  Marshaller.setProperty(String, String), Unmarshaller.setProperty(String, String)

• setDoctypes

  public void setDoctypes​(Map<String,​String> doctypes)

  已过时。
  Set the map containing document type definition for the marshaller. Each entry has system id as key and public id as value.

  另请参阅:

  Marshaller.setDoctype(String, String)

• setProcessingInstructions

  public void setProcessingInstructions​(Map<String,​String> processingInstructions)

  已过时。
  Sets the processing instructions that will be used by during marshalling. Keys are the processing targets and values contain the processing data.

  另请参阅:

  Marshaller.addProcessingInstruction(String, String)

• setNamespaceMappings

  public void setNamespaceMappings​(Map<String,​String> namespaceMappings)

  已过时。
  Set the namespace mappings. Property names are interpreted as namespace prefixes; values are namespace URIs.

  另请参阅:

  Marshaller.setNamespaceMapping(String, String)

• setNamespaceToPackageMapping

  public void setNamespaceToPackageMapping​(Map<String,​String> namespaceToPackageMapping)

  已过时。
  Set the namespace to package mappings. Property names are represents the namespaces URI, values are packages.

  另请参阅:

  Marshaller.setNamespaceMapping(String, String)

• setEntityResolver

  public void setEntityResolver​(EntityResolver entityResolver)

  已过时。
  Set the EntityResolver to be used during unmarshalling. This resolver will used to resolve system and public ids.

  另请参阅:

  Unmarshaller.setEntityResolver(EntityResolver)

• setClassDescriptorResolver

  public void setClassDescriptorResolver​(org.exolab.castor.xml.XMLClassDescriptorResolver classDescriptorResolver)

  已过时。
  Set the XMLClassDescriptorResolver to be used during unmarshalling. This resolver will used to resolve class descriptors.

  另请参阅:

  Unmarshaller.setResolver(XMLClassDescriptorResolver)

• setIdResolver

  public void setIdResolver​(org.exolab.castor.xml.IDResolver idResolver)

  已过时。
  Set the Castor IDResolver to be used during unmarshalling.

  另请参阅:

  Unmarshaller.setIDResolver(IDResolver)

• setObjectFactory

  public void setObjectFactory​(org.exolab.castor.util.ObjectFactory objectFactory)

  已过时。
  Set the Castor ObjectFactory to be used during unmarshalling.

  另请参阅:

  Unmarshaller.setObjectFactory(ObjectFactory)

• setBeanClassLoader

  public void setBeanClassLoader​(ClassLoader classLoader)

  已过时。
  从接口复制的说明: BeanClassLoaderAware
  Callback that supplies the bean class loader to a bean instance.

  Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean'sInitializingBean.afterPropertiesSet() method or a custom init-method.

  指定者:

  setBeanClassLoader 在接口中 BeanClassLoaderAware

  参数:

  classLoader - the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via ClassUtils.getDefaultClassLoader()

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws CastorMappingException,
                                 IOException

  已过时。
  从接口复制的说明: InitializingBean
  Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

  This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

  抛出:

  CastorMappingException

  IOException

• createXMLContext

  protected org.exolab.castor.xml.XMLContext createXMLContext​(Resource[] mappingLocations,
                                                              Class<?>[] targetClasses,
                                                              String[] targetPackages)
                                                       throws org.exolab.castor.mapping.MappingException,
                                                              org.exolab.castor.xml.ResolverException,
                                                              IOException

  已过时。
  Create the Castor XMLContext. Subclasses can override this to create a custom context.

  The default implementation loads mapping files if defined, or the target class or packages if defined.

  返回:

  the created resolver

  抛出:

  org.exolab.castor.mapping.MappingException - when the mapping file cannot be loaded

  IOException - in case of I/O errors

  org.exolab.castor.xml.ResolverException

  另请参阅:

  XMLContext.addMapping(org.exolab.castor.mapping.Mapping), XMLContext.addClass(Class)

• supports

  public boolean supports​(Class<?> clazz)

  已过时。
  Returns true for all classes, i.e. Castor supports arbitrary classes.

  指定者:

  supports 在接口中 Marshaller

  指定者:

  supports 在接口中 Unmarshaller

  参数:

  clazz - the class that this marshaller is being asked if it can marshal

  返回:

  true if this marshaller can indeed marshal instances of the supplied class; false otherwise

• marshalDomNode

  protected void marshalDomNode​(Object graph,
                                Node node)
                         throws XmlMappingException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for marshalling the given object graph to a DOM Node.

  In practice, node is be a Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.

  指定者:

  marshalDomNode 在类中 AbstractMarshaller

  参数:

  graph - the root of the object graph to marshal

  node - the DOM node that will contain the result tree

  抛出:

  XmlMappingException - if the given object cannot be marshalled to the DOM node

  另请参阅:

  Document, DocumentFragment, Element

• marshalXmlEventWriter

  protected void marshalXmlEventWriter​(Object graph,
                                       XMLEventWriter eventWriter)
                                throws XmlMappingException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for marshalling the given object to a StAX XMLEventWriter.

  指定者:

  marshalXmlEventWriter 在类中 AbstractMarshaller

  参数:

  graph - the root of the object graph to marshal

  eventWriter - the XMLEventWriter to write to

  抛出:

  XmlMappingException - if the given object cannot be marshalled to the DOM node

• marshalXmlStreamWriter

  protected void marshalXmlStreamWriter​(Object graph,
                                        XMLStreamWriter streamWriter)
                                 throws XmlMappingException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for marshalling the given object to a StAX XMLStreamWriter.

  指定者:

  marshalXmlStreamWriter 在类中 AbstractMarshaller

  参数:

  graph - the root of the object graph to marshal

  streamWriter - the XMLStreamWriter to write to

  抛出:

  XmlMappingException - if the given object cannot be marshalled to the DOM node

• marshalSaxHandlers

  protected void marshalSaxHandlers​(Object graph,
                                    ContentHandler contentHandler,
                                    LexicalHandler lexicalHandler)
                             throws XmlMappingException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for marshalling the given object graph to a SAX ContentHandler.

  指定者:

  marshalSaxHandlers 在类中 AbstractMarshaller

  参数:

  graph - the root of the object graph to marshal

  contentHandler - the SAX ContentHandler

  lexicalHandler - the SAX2 LexicalHandler. Can be null.

  抛出:

  XmlMappingException - if the given object cannot be marshalled to the handlers

• marshalOutputStream

  protected void marshalOutputStream​(Object graph,
                                     OutputStream outputStream)
                              throws XmlMappingException,
                                     IOException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for marshalling the given object graph to a OutputStream.

  指定者:

  marshalOutputStream 在类中 AbstractMarshaller

  参数:

  graph - the root of the object graph to marshal

  outputStream - the OutputStream to write to

  抛出:

  XmlMappingException - if the given object cannot be marshalled to the writer

  IOException - if an I/O exception occurs

• marshalWriter

  protected void marshalWriter​(Object graph,
                               Writer writer)
                        throws XmlMappingException,
                               IOException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for marshalling the given object graph to a Writer.

  指定者:

  marshalWriter 在类中 AbstractMarshaller

  参数:

  graph - the root of the object graph to marshal

  writer - the Writer to write to

  抛出:

  XmlMappingException - if the given object cannot be marshalled to the writer

  IOException - if an I/O exception occurs

• customizeMarshaller

  protected void customizeMarshaller​(org.exolab.castor.xml.Marshaller marshaller)

  已过时。
  Template method that allows for customizing of the given Castor Marshaller.

• unmarshalDomNode

  protected Object unmarshalDomNode​(Node node)
                             throws XmlMappingException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for unmarshalling from a given DOM Node.

  指定者:

  unmarshalDomNode 在类中 AbstractMarshaller

  参数:

  node - the DOM node that contains the objects to be unmarshalled

  返回:

  the object graph

  抛出:

  XmlMappingException - if the given DOM node cannot be mapped to an object

• unmarshalXmlEventReader

  protected Object unmarshalXmlEventReader​(XMLEventReader eventReader)

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for unmarshalling from a given Stax XMLEventReader.

  指定者:

  unmarshalXmlEventReader 在类中 AbstractMarshaller

  参数:

  eventReader - the XMLEventReader to read from

  返回:

  the object graph

• unmarshalXmlStreamReader

  protected Object unmarshalXmlStreamReader​(XMLStreamReader streamReader)

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for unmarshalling from a given Stax XMLStreamReader.

  指定者:

  unmarshalXmlStreamReader 在类中 AbstractMarshaller

  参数:

  streamReader - the XMLStreamReader to read from

  返回:

  the object graph

• unmarshalSaxReader

  protected Object unmarshalSaxReader​(XMLReader xmlReader,
                                      InputSource inputSource)
                               throws XmlMappingException,
                                      IOException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for unmarshalling using a given SAX XMLReader and InputSource.

  指定者:

  unmarshalSaxReader 在类中 AbstractMarshaller

  参数:

  xmlReader - the SAX XMLReader to parse with

  inputSource - the input source to parse from

  返回:

  the object graph

  抛出:

  XmlMappingException - if the given reader and input source cannot be converted to an object

  IOException - if an I/O exception occurs

• unmarshalInputStream

  protected Object unmarshalInputStream​(InputStream inputStream)
                                 throws XmlMappingException,
                                        IOException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for unmarshalling from a given InputStream.

  指定者:

  unmarshalInputStream 在类中 AbstractMarshaller

  参数:

  inputStream - the InputStreamStream to read from

  返回:

  the object graph

  抛出:

  XmlMappingException - if the given stream cannot be converted to an object

  IOException - if an I/O exception occurs

• unmarshalReader

  protected Object unmarshalReader​(Reader reader)
                            throws XmlMappingException,
                                   IOException

  已过时。
  从类复制的说明: AbstractMarshaller
  Abstract template method for unmarshalling from a given Reader.

  指定者:

  unmarshalReader 在类中 AbstractMarshaller

  参数:

  reader - the Reader to read from

  返回:

  the object graph

  抛出:

  XmlMappingException - if the given reader cannot be converted to an object

  IOException - if an I/O exception occurs

• customizeUnmarshaller

  protected void customizeUnmarshaller​(org.exolab.castor.xml.Unmarshaller unmarshaller)

  已过时。
  Template method that allows for customizing of the given Castor Unmarshaller.

• convertCastorException

  protected XmlMappingException convertCastorException​(org.exolab.castor.xml.XMLException ex,
                                                       boolean marshalling)

  已过时。
  Convert the given XMLException to an appropriate exception from the org.springframework.oxm hierarchy.

  A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since Castor itself does not make this distinction in its exception hierarchy.

  参数:

  ex - Castor XMLException that occurred

  marshalling - indicates whether the exception occurs during marshalling (true), or unmarshalling (false)

  返回:

  the corresponding XmlMappingException