1/*
2 * Copyright 2012, Google Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 *     * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *     * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
14 * distribution.
15 *     * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32package org.jf.dexlib2.builder;
33
34import org.jf.dexlib2.Format;
35import org.jf.dexlib2.Opcode;
36import org.jf.dexlib2.iface.instruction.Instruction;
37import org.jf.dexlib2.util.Preconditions;
38
39import javax.annotation.Nonnull;
40import javax.annotation.Nullable;
41
42public abstract class BuilderInstruction implements Instruction {
43    @Nonnull protected final Opcode opcode;
44
45    @Nullable MethodLocation location;
46
47    protected BuilderInstruction(@Nonnull Opcode opcode) {
48        Preconditions.checkFormat(opcode, getFormat());
49        this.opcode = opcode;
50    }
51
52    @Nonnull public Opcode getOpcode() {
53        return opcode;
54    }
55
56    public abstract Format getFormat();
57
58    public int getCodeUnits() {
59        return getFormat().size / 2;
60    }
61
62    @Nonnull
63    public MethodLocation getLocation() {
64        if (location == null) {
65            throw new IllegalStateException("Cannot get the location of an instruction that hasn't been added to a " +
66                    "method.");
67        }
68        return location;
69    }
70}
71