001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2025 microBean™.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
006 * the License. You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
011 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
012 * specific language governing permissions and limitations under the License.
013 */
014package org.microbean.attributes;
015
016import java.lang.constant.ClassDesc;
017import java.lang.constant.DynamicConstantDesc;
018import java.lang.constant.MethodHandleDesc;
019import java.lang.constant.MethodTypeDesc;
020
021import java.util.Optional;
022
023import static java.lang.constant.ConstantDescs.BSM_INVOKE;
024import static java.lang.constant.ConstantDescs.CD_int;
025import static java.lang.constant.DirectMethodHandleDesc.Kind.STATIC;
026
027/**
028 * A {@link Value} whose value is an {@code int}.
029 *
030 * @param value the value
031 *
032 * @author <a href="https://about.me/lairdnelson" target="_top">Laird Nelson</a>
033 */
034public final record IntValue(int value) implements Value<IntValue> {
035
036  public static final IntValue NEGATIVE_ONE = new IntValue(-1);
037
038  public static final IntValue ZERO = new IntValue(0);
039
040  public static final IntValue ONE = new IntValue(1);
041
042  @Override // Comparable<IntValue>
043  public final int compareTo(final IntValue other) {
044    if (other == null) {
045      return -1;
046    } else if (this.equals(other)) {
047      return 0;
048    }
049    return this.value() > other.value() ? 1 : -1;
050  }
051
052  @Override // Constable
053  public final Optional<DynamicConstantDesc<IntValue>> describeConstable() {
054    final ClassDesc cd = ClassDesc.of(this.getClass().getName());
055    return
056      Optional.of(DynamicConstantDesc.of(BSM_INVOKE,
057                                         MethodHandleDesc.ofMethod(STATIC,
058                                                                   cd,
059                                                                   "of",
060                                                                   MethodTypeDesc.of(cd,
061                                                                                     CD_int)),
062                                         Integer.valueOf(this.value())));
063  }
064
065  @Override // Record
066  public final boolean equals(final Object other) {
067    return
068      other == this ||
069      // Follow java.lang.annotation.Annotation requirements.
070      other != null && other.getClass() == this.getClass() && this.value() == ((IntValue)other).value();
071  }
072
073  @Override // Record
074  public final int hashCode() {
075    // Follow java.lang.annotation.Annotation requirements.
076    return Integer.valueOf(this.value()).hashCode();
077  }
078
079  @Override // Record
080  public final String toString() {
081    return String.valueOf(this.value());
082  }
083
084  /**
085   * Returns an {@link IntValue} suitable for the supplied arguments.
086   *
087   * @param i am {@code int}
088   *
089   * @return a non-{@code null} {@link IntValue}
090   */
091  public static final IntValue of(final int i) {
092    return switch (i) {
093    case -1 -> NEGATIVE_ONE;
094    case 0 -> ZERO;
095    case 1 -> ONE;
096    default -> new IntValue(i);
097    };
098  }
099
100}