All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.buession.core.serializer.Serializer Maven / Gradle / Ivy

There is a newer version: 2.3.3
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
 * See the NOTICE file distributed with this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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.
 *
 * =========================================================================================================
 *
 * This software consists of voluntary contributions made by many individuals on behalf of the
 * Apache Software Foundation. For more information on the Apache Software Foundation, please see
 * .
 *
 * +-------------------------------------------------------------------------------------------------------+
 * | License: http://www.apache.org/licenses/LICENSE-2.0.txt 										       |
 * | Author: Yong.Teng  													       |
 * | Copyright @ 2013-2020 Buession.com Inc.														       |
 * +-------------------------------------------------------------------------------------------------------+
 */
package com.buession.core.serializer;

import java.nio.charset.Charset;

/**
 * @author Yong.Teng
 */
public interface Serializer {

	/**
	 * 将对象序列化为字符串
	 *
	 * @param object
	 * 		待序列化对象
	 * @param 
	 * 		待序列化对象类型
	 *
	 * @return 序列化后的字符串
	 *
	 * @throws SerializerException
	 * 		序列化异常
	 */
	 String serialize(final V object) throws SerializerException;

	/**
	 * 将对象序列化为字符串
	 *
	 * @param object
	 * 		待序列化对象
	 * @param charsetName
	 * 		字符集
	 * @param 
	 * 		待序列化对象类型
	 *
	 * @return 序列化后的字符串
	 *
	 * @throws SerializerException
	 * 		序列化异常
	 */
	 String serialize(final V object, final String charsetName) throws SerializerException;

	/**
	 * 将对象序列化为字符串
	 *
	 * @param object
	 * 		待序列化对象
	 * @param charset
	 * 		字符集
	 * @param 
	 * 		待序列化对象类型
	 *
	 * @return 序列化后的字符串
	 *
	 * @throws SerializerException
	 * 		序列化异常
	 */
	 String serialize(final V object, final Charset charset) throws SerializerException;

	/**
	 * 将对象序列化为字节
	 *
	 * @param object
	 * 		待序列化对象
	 * @param 
	 * 		待序列化对象类型
	 *
	 * @return 序列化后的字节
	 *
	 * @throws SerializerException
	 * 		序列化异常
	 */
	 byte[] serializeAsBytes(final V object) throws SerializerException;

	/**
	 * 将对象序列化为字节
	 *
	 * @param object
	 * 		待序列化对象
	 * @param charsetName
	 * 		字符集
	 * @param 
	 * 		待序列化对象类型
	 *
	 * @return 序列化后的字节
	 *
	 * @throws SerializerException
	 * 		序列化异常
	 */
	 byte[] serializeAsBytes(final V object, final String charsetName) throws SerializerException;

	/**
	 * 将对象序列化为字节
	 *
	 * @param object
	 * 		待序列化对象
	 * @param charset
	 * 		字符集
	 * @param 
	 * 		待序列化对象类型
	 *
	 * @return 序列化后的字节
	 *
	 * @throws SerializerException
	 * 		序列化异常
	 */
	 byte[] serializeAsBytes(final V object, final Charset charset) throws SerializerException;

	/**
	 * 字符串反序列化
	 *
	 * @param str
	 * 		待反序列化字符串
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	 V deserialize(final String str) throws SerializerException;

	/**
	 * 字符串反序列化
	 *
	 * @param str
	 * 		待反序列化字符串
	 * @param charsetName
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	 V deserialize(final String str, final String charsetName) throws SerializerException;

	/**
	 * 字符串反序列化
	 *
	 * @param str
	 * 		待反序列化字符串
	 * @param charset
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	 V deserialize(final String str, final Charset charset) throws SerializerException;

	/**
	 * 字节反序列化
	 *
	 * @param bytes
	 * 		待反序列化的字节
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后的对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	 V deserialize(final byte[] bytes) throws SerializerException;

	/**
	 * 字节反序列化
	 *
	 * @param bytes
	 * 		待反序列化的字节
	 * @param charsetName
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后的对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	 V deserialize(final byte[] bytes, final String charsetName) throws SerializerException;

	/**
	 * 字节反序列化
	 *
	 * @param bytes
	 * 		待反序列化的字节
	 * @param charset
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后的对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	 V deserialize(final byte[] bytes, final Charset charset) throws SerializerException;

	/**
	 * 字符串反序列化
	 *
	 * @param str
	 * 		待反序列化字符串
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	default  V unserialize(final String str) throws SerializerException{
		return deserialize(str);
	}

	/**
	 * 字符串反序列化
	 *
	 * @param str
	 * 		待反序列化字符串
	 * @param charsetName
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	default  V unserialize(final String str, final String charsetName) throws SerializerException{
		return deserialize(str, charsetName);
	}

	/**
	 * 字符串反序列化
	 *
	 * @param str
	 * 		待反序列化字符串
	 * @param charset
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	default  V unserialize(final String str, final Charset charset) throws SerializerException{
		return deserialize(str, charset);
	}

	/**
	 * 字节反序列化
	 *
	 * @param bytes
	 * 		待反序列化的字节
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后的对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	default  V unserialize(final byte[] bytes) throws SerializerException{
		return deserialize(bytes);
	}

	/**
	 * 字节反序列化
	 *
	 * @param bytes
	 * 		待反序列化的字节
	 * @param charsetName
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	default  V unserialize(final byte[] bytes, final String charsetName) throws SerializerException{
		return deserialize(bytes, charsetName);
	}

	/**
	 * 字节反序列化
	 *
	 * @param bytes
	 * 		待反序列化的字节
	 * @param charset
	 * 		字符集
	 * @param 
	 * 		待反序列化对象类型
	 *
	 * @return 反序列化后对象
	 *
	 * @throws SerializerException
	 * 		反序列化异常
	 */
	default  V unserialize(final byte[] bytes, final Charset charset) throws SerializerException{
		return deserialize(bytes, charset);
	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy