org.simpleframework.xml.filter.PlatformFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of simple-xml Show documentation

Simple is a high performance XML serialization and configuration framework for Java

The newest version!

/*
 * PlatformFilter.java May 2006
 *
 * Copyright (C) 2006, Niall Gallagher 
 *
 * 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.simpleframework.xml.filter;

import java.util.Map;

/**
 * The PlatformFilter object makes use of all filter
 * types this resolves user specified properties first, followed
 * by system properties, and finally environment variables. This
 * filter will be the default filter used by most applications as
 * it can make use of all values within the application platform.
 * 
 * @author Niall Gallagher 
 */
public class PlatformFilter extends StackFilter {

   /**
    * Constructor for the PlatformFilter object. This
    * adds a filter which can be used to resolve environment 
    * variables followed by one that can be used to resolve system
    * properties and finally one to resolve user specified values.
    */
   public PlatformFilter() {
      this(null);
   }
   
   /**
    * Constructor for the PlatformFilter object. This
    * adds a filter which can be used to resolve environment 
    * variables followed by one that can be used to resolve system
    * properties and finally one to resolve user specified values.
    * 
    * @param map this is a map contain the user mappings
    */
   public PlatformFilter(Map map) {
      this.push(new EnvironmentFilter());
      this.push(new SystemFilter());
      this.push(new MapFilter(map));      
   }        
}