/*
 * 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.
 */
package org.apache.giraph.debugger.utils;

import org.apache.hadoop.io.WritableComparable;

/**
 * Base wrapper class for {@link GiraphVertexScenarioWrapper},
 * {@link MsgIntegrityViolationWrapper},
 * {@link VertexValueIntegrityViolationWrapper}.
 *
 * author: semihsalihoglu
 *
 * @param <I>
 *          Vertex id
 */
@SuppressWarnings("rawtypes")
public abstract class BaseScenarioAndIntegrityWrapper<
  I extends WritableComparable> extends BaseWrapper {
  /**
   * Class of the type of the vertex IDs.
   */
  protected Class<I> vertexIdClass;

  /**
   * Default empty constructor.
   */
  protected BaseScenarioAndIntegrityWrapper() { };

  /**
   * Default constructor initializing the vertexIdClass.
   * @param vertexIdClass vertex id class.
   */
  public BaseScenarioAndIntegrityWrapper(Class<I> vertexIdClass) {
    initialize(vertexIdClass);
  }

  public Class<I> getVertexIdClass() {
    return vertexIdClass;
  }

  /**
   * Initializes vertex id class.
   * @param vertexIdClass vertex id class.
   */
  public void initialize(Class<I> vertexIdClass) {
    this.vertexIdClass = vertexIdClass;
  }

  @Override
  public String toString() {
    return "\nvertexIdClass: " + getVertexIdClass().getCanonicalName();
  }
}