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.Attribute;
033import io.ebean.enhance.asm.ByteVector;
034import io.ebean.enhance.asm.ClassReader;
035import io.ebean.enhance.asm.ClassWriter;
036import io.ebean.enhance.asm.Label;
037
038/**
039 * A ModuleResolution attribute. This attribute is specific to the OpenJDK and may change in the
040 * future.
041 *
042 * @author Remi Forax
043 */
044public final class ModuleResolutionAttribute extends Attribute {
045  /**
046   * The resolution state of a module meaning that the module is not available from the class-path
047   * by default.
048   */
049  public static final int RESOLUTION_DO_NOT_RESOLVE_BY_DEFAULT = 1;
050
051  /** The resolution state of a module meaning the module is marked as deprecated. */
052  public static final int RESOLUTION_WARN_DEPRECATED = 2;
053
054  /**
055   * The resolution state of a module meaning the module is marked as deprecated and will be removed
056   * in a future release.
057   */
058  public static final int RESOLUTION_WARN_DEPRECATED_FOR_REMOVAL = 4;
059
060  /**
061   * The resolution state of a module meaning the module is not yet standardized, so in incubating
062   * mode.
063   */
064  public static final int RESOLUTION_WARN_INCUBATING = 8;
065
066  /**
067   * The resolution state of the module. Must be one of {@link #RESOLUTION_WARN_DEPRECATED}, {@link
068   * #RESOLUTION_WARN_DEPRECATED_FOR_REMOVAL}, and {@link #RESOLUTION_WARN_INCUBATING}.
069   */
070  public int resolution;
071
072  /**
073   * Constructs a new {@link ModuleResolutionAttribute}.
074   *
075   * @param resolution the resolution state of the module. Must be one of {@link
076   *     #RESOLUTION_WARN_DEPRECATED}, {@link #RESOLUTION_WARN_DEPRECATED_FOR_REMOVAL}, and {@link
077   *     #RESOLUTION_WARN_INCUBATING}.
078   */
079  public ModuleResolutionAttribute(final int resolution) {
080    super("ModuleResolution");
081    this.resolution = resolution;
082  }
083
084  /**
085   * Constructs an empty {@link ModuleResolutionAttribute}. This object can be passed as a prototype
086   * to the {@link ClassReader#accept(ClassVisitor, Attribute[], int)} method.
087   */
088  public ModuleResolutionAttribute() {
089    this(0);
090  }
091
092  @Override
093  protected Attribute read(
094      final ClassReader classReader,
095      final int offset,
096      final int length,
097      final char[] charBuffer,
098      final int codeOffset,
099      final Label[] labels) {
100    return new ModuleResolutionAttribute(classReader.readUnsignedShort(offset));
101  }
102
103  @Override
104  protected ByteVector write(
105      final ClassWriter classWriter,
106      final byte[] code,
107      final int codeLength,
108      final int maxStack,
109      final int maxLocals) {
110    ByteVector byteVector = new ByteVector();
111    byteVector.putShort(resolution);
112    return byteVector;
113  }
114}