LegacyConverter.java

/*
 * The MIT License
 *
 * Copyright (c) 2011, Oracle Corporation, Nikita Levyankov
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package hudson.plugins.git.converter;

import com.thoughtworks.xstream.converters.UnmarshallingContext;
import com.thoughtworks.xstream.io.HierarchicalStreamReader;

/**
 * This interface is used for legacy classes conversion
 * <p/>
 * Date: 7/1/11
 *
 * @author Nikita Levyankov
 */
public interface LegacyConverter<T> {
    /**
     * Is the current reader node a legacy node?
     *
     * @param reader HierarchicalStreamReader.
     * @param context UnmarshallingContext.
     * @return true if legacy, false otherwise
     */
    boolean isLegacyNode(HierarchicalStreamReader reader, UnmarshallingContext context);

    /**
     * Unmarshall legacy object.
     *
     * @param reader HierarchicalStreamReader.
     * @param context UnmarshallingContext.
     * @return unmarshalled object of specified type
     */
    T legacyUnmarshal(HierarchicalStreamReader reader, UnmarshallingContext context);
}