Open Source Repository

Home /spring/spring-beans-3.0.5 | Repository Home


org/springframework/beans/support/ResourceEditorRegistrar.java
/*
 * Copyright 2002-2010 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.beans.support;

import java.beans.PropertyEditor;
import java.io.File;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;

import org.xml.sax.InputSource;

import org.springframework.beans.PropertyEditorRegistrar;
import org.springframework.beans.PropertyEditorRegistry;
import org.springframework.beans.PropertyEditorRegistrySupport;
import org.springframework.beans.propertyeditors.ClassArrayEditor;
import org.springframework.beans.propertyeditors.ClassEditor;
import org.springframework.beans.propertyeditors.FileEditor;
import org.springframework.beans.propertyeditors.InputSourceEditor;
import org.springframework.beans.propertyeditors.InputStreamEditor;
import org.springframework.beans.propertyeditors.URIEditor;
import org.springframework.beans.propertyeditors.URLEditor;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceEditor;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.io.support.ResourceArrayPropertyEditor;
import org.springframework.core.io.support.ResourcePatternResolver;

/**
 * PropertyEditorRegistrar implementation that populates a given
 {@link org.springframework.beans.PropertyEditorRegistry}
 * (typically a {@link org.springframework.beans.BeanWrapper} used for bean
 * creation within an {@link org.springframework.context.ApplicationContext})
 * with resource editors. Used by
 {@link org.springframework.context.support.AbstractApplicationContext}.
 *
 @author Juergen Hoeller
 @since 2.0
 */
public class ResourceEditorRegistrar implements PropertyEditorRegistrar {

  private final ResourceLoader resourceLoader;


  /**
   * Create a new ResourceEditorRegistrar for the given ResourceLoader
   @param resourceLoader the ResourceLoader (or ResourcePatternResolver)
   * to create editors for (usually an ApplicationContext)
   @see org.springframework.core.io.support.ResourcePatternResolver
   @see org.springframework.context.ApplicationContext
   */
  public ResourceEditorRegistrar(ResourceLoader resourceLoader) {
    this.resourceLoader = resourceLoader;
  }


  /**
   * Populate the given bean factory with the following resource editors:
   * ResourceEditor, InputStreamEditor, FileEditor, URLEditor, ClassEditor, URIEditor.
   <p>In case of a {@link org.springframework.core.io.support.ResourcePatternResolver},
   * a ResourceArrayPropertyEditor will be registered as well.
   @see org.springframework.core.io.ResourceEditor
   @see org.springframework.beans.propertyeditors.InputStreamEditor
   @see org.springframework.beans.propertyeditors.FileEditor
   @see org.springframework.beans.propertyeditors.URLEditor
   @see org.springframework.beans.propertyeditors.ClassEditor
   @see org.springframework.beans.propertyeditors.URIEditor
   @see org.springframework.core.io.support.ResourceArrayPropertyEditor
   */
  public void registerCustomEditors(PropertyEditorRegistry registry) {
    ResourceEditor baseEditor = new ResourceEditor(this.resourceLoader);
    doRegisterEditor(registry, Resource.class, baseEditor);
    doRegisterEditor(registry, InputStream.class, new InputStreamEditor(baseEditor));
    doRegisterEditor(registry, InputSource.class, new InputSourceEditor(baseEditor));
    doRegisterEditor(registry, File.class, new FileEditor(baseEditor));
    doRegisterEditor(registry, URL.class, new URLEditor(baseEditor));

    ClassLoader classLoader = this.resourceLoader.getClassLoader();
    doRegisterEditor(registry, URI.class, new URIEditor(classLoader));
    doRegisterEditor(registry, Class.class, new ClassEditor(classLoader));
    doRegisterEditor(registry, Class[].class, new ClassArrayEditor(classLoader));

    if (this.resourceLoader instanceof ResourcePatternResolver) {
      doRegisterEditor(registry, Resource[].class,
          new ResourceArrayPropertyEditor((ResourcePatternResolverthis.resourceLoader));
    }
  }

  /**
   * Override default editor, if possible (since that's what we really mean to do here);
   * otherwise register as a custom editor.
   */
  private void doRegisterEditor(PropertyEditorRegistry registry, Class requiredType, PropertyEditor editor) {
    if (registry instanceof PropertyEditorRegistrySupport) {
      ((PropertyEditorRegistrySupportregistry).overrideDefaultEditor(requiredType, editor);
    }
    else {
      registry.registerCustomEditor(requiredType, editor);
    }
  }

}