001// ASM: a very small and fast Java bytecode manipulation framework
002// Copyright (c) 2000-2011 INRIA, France Telecom
003// All rights reserved.
004//
005// Redistribution and use in source and binary forms, with or without
006// modification, are permitted provided that the following conditions
007// are met:
008// 1. Redistributions of source code must retain the above copyright
009//    notice, this list of conditions and the following disclaimer.
010// 2. Redistributions in binary form must reproduce the above copyright
011//    notice, this list of conditions and the following disclaimer in the
012//    documentation and/or other materials provided with the distribution.
013// 3. Neither the name of the copyright holders nor the names of its
014//    contributors may be used to endorse or promote products derived from
015//    this software without specific prior written permission.
016//
017// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
020// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
021// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
022// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
023// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
024// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
025// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
026// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
027// THE POSSIBILITY OF SUCH DAMAGE.
028
029package io.ebean.enhance.asm.commons;
030
031import io.ebean.enhance.asm.*;
032import io.ebean.enhance.asm.ByteVector;
033
034/**
035 * A ModuleResolution attribute. This attribute is specific to the OpenJDK and may change in the
036 * future.
037 *
038 * @author Remi Forax
039 */
040public final class ModuleResolutionAttribute extends Attribute {
041  /**
042   * The resolution state of a module meaning that the module is not available from the class-path
043   * by default.
044   */
045  public static final int RESOLUTION_DO_NOT_RESOLVE_BY_DEFAULT = 1;
046
047  /** The resolution state of a module meaning the module is marked as deprecated. */
048  public static final int RESOLUTION_WARN_DEPRECATED = 2;
049
050  /**
051   * The resolution state of a module meaning the module is marked as deprecated and will be removed
052   * in a future release.
053   */
054  public static final int RESOLUTION_WARN_DEPRECATED_FOR_REMOVAL = 4;
055
056  /**
057   * The resolution state of a module meaning the module is not yet standardized, so in incubating
058   * mode.
059   */
060  public static final int RESOLUTION_WARN_INCUBATING = 8;
061
062  /**
063   * The resolution state of the module. Must be one of {@link #RESOLUTION_WARN_DEPRECATED}, {@link
064   * #RESOLUTION_WARN_DEPRECATED_FOR_REMOVAL}, and {@link #RESOLUTION_WARN_INCUBATING}.
065   */
066  public int resolution;
067
068  /**
069   * Constructs a new {@link ModuleResolutionAttribute}.
070   *
071   * @param resolution the resolution state of the module. Must be one of {@link
072   *     #RESOLUTION_WARN_DEPRECATED}, {@link #RESOLUTION_WARN_DEPRECATED_FOR_REMOVAL}, and {@link
073   *     #RESOLUTION_WARN_INCUBATING}.
074   */
075  public ModuleResolutionAttribute(final int resolution) {
076    super("ModuleResolution");
077    this.resolution = resolution;
078  }
079
080  /**
081   * Constructs an empty {@link ModuleResolutionAttribute}. This object can be passed as a prototype
082   * to the {@link ClassReader#accept(ClassVisitor, Attribute[], int)} method.
083   */
084  public ModuleResolutionAttribute() {
085    this(0);
086  }
087
088  @Override
089  protected Attribute read(
090      final ClassReader classReader,
091      final int offset,
092      final int length,
093      final char[] charBuffer,
094      final int codeOffset,
095      final Label[] labels) {
096    return new ModuleResolutionAttribute(classReader.readUnsignedShort(offset));
097  }
098
099  @Override
100  protected ByteVector write(
101      final ClassWriter classWriter,
102      final byte[] code,
103      final int codeLength,
104      final int maxStack,
105      final int maxLocals) {
106    ByteVector byteVector = new ByteVector();
107    byteVector.putShort(resolution);
108    return byteVector;
109  }
110}