org.nervousync.beans.converter.Adapter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of utils-jdk11 Show documentation

Java utility collections, development by Nervousync Studio (NSYC)

There is a newer version: 1.2.1

/*
 * Licensed to the Nervousync Studio (NSYC) 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.
 */
package org.nervousync.beans.converter;

/**
 * DataConverter interface class
 * 数据转换器接口类
 *
 * @author Steven Wee	[email protected]
 * @version $Revision: 1.0.0 $ $Date: Jun 21, 2023 11:22:15 $
 */
public interface Adapter {
    /**
     * Encode object to target type
     * 将对象编码为指定类型
     *
     * @param object    Target object instance
     *                  目标对象实例
     *
     * @return          Encoded object instance or null if target object instance is null
     *                  转换后的对象，如果目标对象实例为空，则返回null
     * @throws Exception
     * If an error occurs when execute
     * 当执行时出现错误
     */
    BoundType unmarshal(final ValueType object) throws Exception;
    /**
     * Decode target instance to object
     * 将给定的对象解码为对象
     *
     * @param object    Source object instance
     *                  源对象实例
     *
     * @return          Decode object instance
     *                  解码后的对象实例
     * @throws Exception
     * If an error occurs when execute
     * 当执行时出现错误
     */
    ValueType marshal(final BoundType object) throws Exception;
}