/* Software Name : AsmDex
 * Version : 1.0
 *
 * Copyright © 2012 France Télécom
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.ow2.asmdex.instruction;

import org.ow2.asmdex.structureCommon.Label;

/**
 * Interface for a Dalvik instruction with one offset.
 * 
 * @author Julien Névo
 */
public interface IOffsetInstruction {

	/**
	 * Returns the offset of the instruction this instruction is related to.
	 * @return the offset of the instruction this instruction is related to.
	 */
	int getOffset();
	
	/**
	 * Offset in bytes of the Instruction from the beginning of the method.
	 * This is only useful for the Instruction that refers to Labels, so that we can know if the range
	 * of the Instruction is valid to reach the Label.
	 * @return offset in bytes of the Instruction from the beginning of the method.
	 */
	int getInstructionOffset();
	
	/**
	 * Sets the offset in bytes of the Instruction from the beginning of the method.
	 * @param instructionOffset offset in bytes of the Instruction from the beginning of the method.
	 */
	void setInstructionOffset(int instructionOffset);
	
	/**
	 * Returns the label to which the instruction is related to.
	 * @return the label to which the instruction is related to.
	 */
	public Label getLabel();
}