Open Source Repository

Home /spring/spring-oxm-3.0.5 | Repository Home



org/springframework/oxm/xmlbeans/XmlOptionsFactoryBean.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.oxm.xmlbeans;

import java.util.Map;

import org.apache.xmlbeans.XmlOptions;

import org.springframework.beans.factory.FactoryBean;

/**
 {@link FactoryBean} that configures an XMLBeans <code>XmlOptions</code> object
 * and provides it as a bean reference.
 *
 <p>Typical usage will be to set XMLBeans options on this bean, and refer to it
 * in the {@link XmlBeansMarshaller}.
 *
 @author Arjen Poutsma
 @since 3.0
 @see XmlOptions
 @see #setOptions(java.util.Map)
 @see XmlBeansMarshaller#setXmlOptions(XmlOptions)
 */
public class XmlOptionsFactoryBean implements FactoryBean<XmlOptions> {

  private XmlOptions xmlOptions;


  /**
   * Set options on the underlying <code>XmlOptions</code> object.
   <p>The keys of the supplied map should be one of the String constants
   * defined in <code>XmlOptions</code>, the values vary per option.
   @see XmlOptions#put(Object,Object)
   @see XmlOptions#SAVE_PRETTY_PRINT
   @see XmlOptions#LOAD_STRIP_COMMENTS
   */
  public void setOptions(Map<String, ?> optionsMap) {
    this.xmlOptions = new XmlOptions();
    if (optionsMap != null) {
      for (String option : optionsMap.keySet()) {
        this.xmlOptions.put(option, optionsMap.get(option));
      }
    }
  }


  public XmlOptions getObject() {
    return this.xmlOptions;
  }

  public Class<? extends XmlOptions> getObjectType() {
    return XmlOptions.class;
  }

  public boolean isSingleton() {
    return true;
  }

}