001/***
002 * ASM: a very small and fast Java bytecode manipulation framework
003 * Copyright (c) 2000-2011 INRIA, France Telecom
004 * All rights reserved.
005 *
006 * Redistribution and use in source and binary forms, with or without
007 * modification, are permitted provided that the following conditions
008 * are met:
009 * 1. Redistributions of source code must retain the above copyright
010 *    notice, this list of conditions and the following disclaimer.
011 * 2. Redistributions in binary form must reproduce the above copyright
012 *    notice, this list of conditions and the following disclaimer in the
013 *    documentation and/or other materials provided with the distribution.
014 * 3. Neither the name of the copyright holders nor the names of its
015 *    contributors may be used to endorse or promote products derived from
016 *    this software without specific prior written permission.
017 *
018 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
021 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
022 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
024 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
025 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
026 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
027 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
028 * THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package io.ebean.enhance.asm.tree;
031
032import io.ebean.enhance.asm.MethodVisitor;
033
034/**
035 * A node that represents a local variable declaration.
036 * 
037 * @author Eric Bruneton
038 */
039public class LocalVariableNode {
040
041    /**
042     * The name of a local variable.
043     */
044    public String name;
045
046    /**
047     * The type descriptor of this local variable.
048     */
049    public String desc;
050
051    /**
052     * The signature of this local variable. May be <tt>null</tt>.
053     */
054    public String signature;
055
056    /**
057     * The first instruction corresponding to the scope of this local variable
058     * (inclusive).
059     */
060    public LabelNode start;
061
062    /**
063     * The last instruction corresponding to the scope of this local variable
064     * (exclusive).
065     */
066    public LabelNode end;
067
068    /**
069     * The local variable's index.
070     */
071    public int index;
072
073    /**
074     * Constructs a new {@link LocalVariableNode}.
075     * 
076     * @param name
077     *            the name of a local variable.
078     * @param desc
079     *            the type descriptor of this local variable.
080     * @param signature
081     *            the signature of this local variable. May be <tt>null</tt>.
082     * @param start
083     *            the first instruction corresponding to the scope of this local
084     *            variable (inclusive).
085     * @param end
086     *            the last instruction corresponding to the scope of this local
087     *            variable (exclusive).
088     * @param index
089     *            the local variable's index.
090     */
091    public LocalVariableNode(final String name, final String desc,
092                             final String signature, final LabelNode start, final LabelNode end,
093                             final int index) {
094        this.name = name;
095        this.desc = desc;
096        this.signature = signature;
097        this.start = start;
098        this.end = end;
099        this.index = index;
100    }
101
102    /**
103     * Makes the given visitor visit this local variable declaration.
104     * 
105     * @param mv
106     *            a method visitor.
107     */
108    public void accept(final MethodVisitor mv) {
109        mv.visitLocalVariable(name, desc, signature, start.getLabel(),
110                end.getLabel(), index);
111    }
112}