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.ModuleVisitor;
033import io.ebean.enhance.asm.Opcodes;
034
035/**
036 * A node that represents a required module with its name and access of a module descriptor.
037 * 
038 * @author Remi Forax
039 */
040public class ModuleRequireNode {
041    /**
042     * The name of the required module.
043     */
044    public String module;
045
046    /**
047     * The access flags (see {@link Opcodes}).
048     * Valid values are <tt>ACC_TRANSITIVE</tt>, <tt>ACC_STATIC_PHASE</tt>,
049     *        <tt>ACC_SYNTHETIC</tt> and <tt>ACC_MANDATED</tt>.
050     */
051    public int access;
052    
053    /**
054     * Version at compile time of the required module or null.
055     */
056    public String version;
057
058    /**
059     * Constructs a new {@link ModuleRequireNode}.
060     * 
061     * @param module
062     *            the name of the required module.
063     * @param access
064     *            The access flags. Valid values are
065     *            <tt>ACC_TRANSITIVE</tt>, <tt>ACC_STATIC_PHASE</tt>,
066     *            <tt>ACC_SYNTHETIC</tt> and <tt>ACC_MANDATED</tt>
067     *            (see {@link Opcodes}).
068     * @param version
069     *            Version of the required module at compile time,
070     *            null if not defined.
071     */
072    public ModuleRequireNode(final String module, final int access,
073            final String version) {
074        this.module = module;
075        this.access = access;
076        this.version = version;
077    }
078
079    /**
080     * Makes the given module visitor visit this require directive.
081     * 
082     * @param mv
083     *            a module visitor.
084     */
085    public void accept(final ModuleVisitor mv) {
086        mv.visitRequire(module, access, version);
087    }
088}