/*
 * Copyright 2012 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * 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.amazon.carbonado.layout;

import com.amazon.carbonado.Alias;
import com.amazon.carbonado.Independent;
import com.amazon.carbonado.Nullable;
import com.amazon.carbonado.PrimaryKey;
import com.amazon.carbonado.Storable;
import com.amazon.carbonado.Version;

/**
 * Maps layout generations which are equivalent.
 *
 * @author Brian S O'Neill
 */
@PrimaryKey({"storableTypeName", "generation"})
@Independent
@Alias("CARBONADO_LAYOUT_EQUIV")
public interface StoredLayoutEquivalence extends Storable<StoredLayoutEquivalence>, Unevolvable {
    /**
     * Storable type name is a fully qualified Java class name.
     */
    String getStorableTypeName();
    void setStorableTypeName(String typeName);

    /**
     * Generation of storable, where 0 represents the first generation.
     */
    int getGeneration();
    void setGeneration(int generation);

    /**
     * Generation of matched layout.
     */
    int getMatchedGeneration();
    void setMatchedGeneration(int generation);

    @Version
    int getVersionNumber();
    void setVersionNumber(int version);

    @Nullable
    byte[] getExtraData();
    void setExtraData(byte[] data);
}