com.googlecode.jmapper.api.Global Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jmapper-core Show documentation

JMapper Framework is a java bean mapper based on javassist. JMapper exposes interesting features as relational mapping, dynamic conversions and more

The newest version!

/**
 * Copyright (C) 2012 - 2016 Alessandro Vurro.
 *
 * 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 com.googlecode.jmapper.api;

import java.util.ArrayList;

import com.googlecode.jmapper.xml.beans.XmlExcludedAttribute;
import com.googlecode.jmapper.xml.beans.XmlGlobal;
import com.googlecode.jmapper.xml.beans.XmlTargetAttribute;
import com.googlecode.jmapper.xml.beans.XmlTargetClass;

/**
 * Global mapping configuration.
 * 
 * @author Alessandro Vurro
 *
 */
public class Global implements Convertible{

	/** xml global node */
	private XmlGlobal global;
	
	public Global() {
		global = new XmlGlobal();
		global.attributes = new ArrayList();
		global.excluded = new ArrayList();
		global.classes = new ArrayList();
	}

	/**
	 * Value setting.
	 * 
	 * @param targetAttribute target field.
	 * @return this instance JMapperGlobal
	 */
	public Global value(TargetAttribute targetAttribute){
		global.value = targetAttribute.toXStream();
		return this;
	}
	
	/**
	 * Attributes to include in mapping.
	 * 
	 * @param includedAattributes included attributes
	 * @return this instance of JMapperGlobal
	 */
	public Global includedAttributes(LocalAttribute... includedAattributes){
		
		for (LocalAttribute attribute : includedAattributes)
			global.attributes.add(attribute.toXStream());
		
		return this;
	}
	
	/**
	 * Attributes to include in mapping.
	 * @param includedAttributes names of the attributes to include in the mapping
	 * @return this instance of JMapperGlobal
	 */
	public Global includedAttributes(String... includedAttributes){
		for (String attribute : includedAttributes)
			global.attributes.add(new LocalAttribute(attribute).toXStream());
		
		return this;
	}
	
	/**
	 * Attributes to exclude from mapping.
	 * 
	 * @param attributes excluded attributes
	 * @return this instance of JMapperGlobal
	 */
	public Global excludedAttributes(String... attributes){
		
		for (String attribute : attributes)
			global.excluded.add(new XmlExcludedAttribute(attribute));
		
		return this;
	}
	
	/**
	 * Target classes.
	 * @param classes target classes
	 * @return this instance of JMapperGlobal
	 */
	public Global targetClasses(Class... classes){
		
		for (Class targetClass : classes) 
			global.classes.add(new TargetClass(targetClass).toXStream());
		
		return this;
	}
	
	public XmlGlobal toXStream() {
		return global;
	}
}