ToMarshaller.java

/*
 *  Copyright 2010, 2011 Sousan Rassoul
 *
 *  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.jadira.bindings.core.api;

/**
 * Interface for explicitly defining conversions to a target object from a specific
 * object type (marshalling).
 * <br>
 * Implementations of this class should be idempotent (behaviour should not vary
 * between calls) and thread-safe. 
 * <br>
 * S refers to the bound type for the conversion <br>
 * T refers to the target type
 */
public interface ToMarshaller<S, T> {

    /**
     * Converts to the given object from the specified object
     * @param object Object to transform, not null
     * @return S converted to T
     */
    T marshal(S object);
    
    /**
     * Obtain the bound class
     * @return Class
     */
    Class<S> getBoundClass();
    
    /**
     * Obtain the bound class
     * @return Class
     */
    Class<T> getTargetClass();
}