com.feilong.xml.xstream.XStreamConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2008 feilong
*
* 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.feilong.xml.xstream;
import static com.feilong.core.util.MapUtil.newHashMap;
import java.util.List;
import java.util.Map;
import com.feilong.lib.xstream.converters.Converter;
import com.feilong.lib.xstream.io.xml.CompactWriter;
import com.feilong.lib.xstream.io.xml.PrettyPrintWriter;
/**
* XStream相关配置.
*
* @author feilong
* @version 1.5.0 2015年10月29日 下午4:48:56
* @since 1.5.0
*/
public final class XStreamConfig{
/**
* 是否格式化输出.
*
* 默认 是true,使用 {@link PrettyPrintWriter},如果设置成false ,将使用 {@link CompactWriter}
*
* @see PrettyPrintWriter
* @see CompactWriter
*/
private boolean isPrettyPrint = true;
//---------------------------------------------------------------
/**
* 哪个类的注解需要被激活.
*
* @see com.feilong.lib.xstream.XStream#processAnnotations(Class[])
*/
private Class[] processAnnotationsTypes;
/**
* 转换器.
*
* @since 1.10.7
*/
private List converterList;
//---------------------------------------------------------------
/**
* 别名.
*
* @see com.feilong.lib.xstream.XStream#alias(String, Class)
*/
private Map> aliasMap = newHashMap();
/** 隐式集合 隐藏,隐藏,比如下面有list,泛型中的第二个参数 Class 是 ownerType. */
private Map> implicitCollectionMap = newHashMap();
/**
* Associate a default implementation of a class with an object.
*
*
* Whenever XStream encounters an instance of this type, it will use the default implementation instead.
* For example, java.util.ArrayList is the default implementation of java.util.List.
*
*
* 说明:
*
*
*
*
{@code
}
*
*
* 在XStream中，如果定义的字段是一个父类或接口，在序列化是会默认加入class属性以确定反序列化时用的类，
* 为了去掉这个class属性，可以定义默认的实现类来解决（虽然感觉这种解决方案不太好，但是目前还没有找到更好的解决方案）:
*
*
* xstream.addDefaultImplementation(LinkedHashMap.class, Map.class);
*
*
*
*
* @see com.feilong.lib.xstream.mapper.ClassAliasingMapper#serializedClass(Class)
* @see com.feilong.lib.xstream.XStream#addDefaultImplementation(Class, Class)
* @see com.feilong.lib.xstream.mapper.DefaultImplementationsMapper#serializedClass(Class)
* @since 1.10.7
*/
private Map, Class> defaultImplementationMap = newHashMap();
//---------------------------------------------------------------
/**
* Instantiates a new x stream config.
*/
public XStreamConfig(){
super();
}
/**
* Instantiates a new x stream config.
*
* @param aliasMap
* 别名,see {@link com.feilong.lib.xstream.XStream#alias(String, Class)}
*/
public XStreamConfig(Map> aliasMap){
this.aliasMap = aliasMap;
}
/**
* Instantiates a new x stream config.
*
* @param aliasName
* the alias name
* @param type
* the type
*/
public XStreamConfig(String aliasName, Class type){
this.aliasMap.put(aliasName, type);
}
/**
* Instantiates a new x stream config.
*
* @param processAnnotationsTypes
* 哪个类的注解需要被激活.
* see {@link com.feilong.lib.xstream.XStream#processAnnotations(Class[])}
*/
public XStreamConfig(Class...processAnnotationsTypes){
this.processAnnotationsTypes = processAnnotationsTypes;
}
//---------------------------------------------------------------
/**
* 获得 别名.
*
* @return the aliasMap
* @see com.feilong.lib.xstream.XStream#alias(String, Class)
*/
public Map> getAliasMap(){
return aliasMap;
}
/**
* 设置 别名.
*
* @param aliasMap
* the aliasMap to set
* @see com.feilong.lib.xstream.XStream#alias(String, Class)
*/
public void setAliasMap(Map> aliasMap){
this.aliasMap = aliasMap;
}
/**
* 获得 隐式集合 隐藏,隐藏,比如下面有list,泛型中的第二个参数 Class 是 ownerType.
*
* @return the implicitCollectionMap
*/
public Map> getImplicitCollectionMap(){
return implicitCollectionMap;
}
/**
* 设置 隐式集合 隐藏,隐藏,比如下面有list,泛型中的第二个参数 Class 是 ownerType.
*
* @param implicitCollectionMap
* the implicitCollectionMap to set
*/
public void setImplicitCollectionMap(Map> implicitCollectionMap){
this.implicitCollectionMap = implicitCollectionMap;
}
/**
* 获得 转换器.
*
* @return the converterList
* @since 1.10.7
*/
public List getConverterList(){
return converterList;
}
/**
* 设置 转换器.
*
* @param converterList
* the converterList to set
* @since 1.10.7
*/
public void setConverterList(List converterList){
this.converterList = converterList;
}
/**
* 哪个类的注解需要被激活.
*
* @return 哪个类的注解需要被激活
* @see com.feilong.lib.xstream.XStream#processAnnotations(Class[])
*/
public Class[] getProcessAnnotationsTypes(){
return processAnnotationsTypes;
}
/**
* 哪个类的注解需要被激活.
*
* @param processAnnotationsTypes
* 哪个类的注解需要被激活
* @see com.feilong.lib.xstream.XStream#processAnnotations(Class[])
*/
public void setProcessAnnotationsTypes(Class[] processAnnotationsTypes){
this.processAnnotationsTypes = processAnnotationsTypes;
}
/**
* 是否格式化输出.
*
* 默认 是true,使用 {@link PrettyPrintWriter},如果设置成false ,将使用 {@link CompactWriter}
*
* @return the isPrettyPrint
* @see PrettyPrintWriter
* @see CompactWriter
*/
public boolean getIsPrettyPrint(){
return isPrettyPrint;
}
/**
* 是否格式化输出.
*
* 默认 是true,使用 {@link PrettyPrintWriter},如果设置成false ,将使用 {@link CompactWriter}
*
* @param isPrettyPrint
* the isPrettyPrint to set
* @see PrettyPrintWriter
* @see CompactWriter
*/
public void setIsPrettyPrint(boolean isPrettyPrint){
this.isPrettyPrint = isPrettyPrint;
}
/**
* Associate a default implementation of a class with an object.
*
*
* Whenever XStream encounters an instance of this type, it will use the default implementation instead.
* For example, java.util.ArrayList is the default implementation of java.util.List.
*
*
* 说明:
*
*
*
*
{@code
}
*
*
* 在XStream中，如果定义的字段是一个父类或接口，在序列化是会默认加入class属性以确定反序列化时用的类，
* 为了去掉这个class属性，可以定义默认的实现类来解决（虽然感觉这种解决方案不太好，但是目前还没有找到更好的解决方案）:
*
*
* xstream.addDefaultImplementation(LinkedHashMap.class, Map.class);
*
*
*
*
* @return the defaultImplementationMap
* @see com.feilong.lib.xstream.mapper.ClassAliasingMapper#serializedClass(Class)
* @see com.feilong.lib.xstream.XStream#addDefaultImplementation(Class, Class)
* @see com.feilong.lib.xstream.mapper.DefaultImplementationsMapper#serializedClass(Class)
* @since 1.10.7
*/
public Map, Class> getDefaultImplementationMap(){
return defaultImplementationMap;
}
/**
* Associate a default implementation of a class with an object.
*
*
* Whenever XStream encounters an instance of this type, it will use the default implementation instead.
* For example, java.util.ArrayList is the default implementation of java.util.List.
*
*
* 说明:
*
*
*
*
{@code
}
*
*
* 在XStream中，如果定义的字段是一个父类或接口，在序列化是会默认加入class属性以确定反序列化时用的类，
* 为了去掉这个class属性，可以定义默认的实现类来解决（虽然感觉这种解决方案不太好，但是目前还没有找到更好的解决方案）:
*
*
* xstream.addDefaultImplementation(LinkedHashMap.class, Map.class);
*
*
*
*
* @param defaultImplementationMap
* the defaultImplementationMap to set
* @see com.feilong.lib.xstream.mapper.ClassAliasingMapper#serializedClass(Class)
* @see com.feilong.lib.xstream.XStream#addDefaultImplementation(Class, Class)
* @see com.feilong.lib.xstream.mapper.DefaultImplementationsMapper#serializedClass(Class)
* @since 1.10.7
*/
public void setDefaultImplementationMap(Map, Class> defaultImplementationMap){
this.defaultImplementationMap = defaultImplementationMap;
}
}