001/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
002 *
003 * Copyright © 2022–2023 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.constant;
015
016import java.lang.constant.ClassDesc;
017
018/**
019 * A utiliy class containing useful {@link java.lang.constant.ConstantDesc}s (mostly {@link ClassDesc}s).
020 *
021 * @author <a href="https://about.me/lairdnelson" target="_parent">Laird Nelson</a>
022 */
023public final class ConstantDescs {
024
025
026  /*
027   * Static fields.
028   */
029
030
031  /**
032   * A {@link ClassDesc} describing {@link java.util.Arrays java.util.Arrays}.
033   *
034   * @nullability This field is never {@code null}.
035   */
036  public static final ClassDesc CD_Arrays = ClassDesc.of("java.util.Arrays");
037
038  /**
039   * A {@link ClassDesc} describing {@link java.util.Collections java.util.Collections}.
040   *
041   * @nullability This field is never {@code null}.
042   */
043  public static final ClassDesc CD_Collections = ClassDesc.of("java.util.Collections");
044
045  /**
046   * A {@link ClassDesc} describing {@link Comparable}.
047   *
048   * @nullability This field is never {@code null}.
049   */
050  public static final ClassDesc CD_Comparable = ClassDesc.of("java.lang.Comparable");
051
052  /**
053   * A {@link ClassDesc} describing {@link java.util.Comparator java.util.Comparator}.
054   *
055   * @nullability This field is never {@code null}.
056   */
057  public static final ClassDesc CD_Comparator = ClassDesc.of("java.util.Comparator");
058
059  /**
060   * A {@link ClassDesc} describing {@link java.lang.constant.Constable java.lang.constant.Constable}.
061   *
062   * @nullability This field is never {@code null}.
063   */
064  public static final ClassDesc CD_Constable = ClassDesc.of("java.lang.constant.Constable");
065
066  /**
067   * A {@link ClassDesc} describing {@link java.util.HashSet java.util.HashSet}.
068   *
069   * @nullability This field is never {@code null}.
070   */
071  public static final ClassDesc CD_Entry = ClassDesc.of("java.util.Map$Entry");
072
073  /**
074   * A {@link ClassDesc} describing {@link java.util.Map.Entry java.util.Map.Entry}.
075   *
076   * @nullability This field is never {@code null}.
077   */
078  public static final ClassDesc CD_HashSet = ClassDesc.of("java.util.HashSet");
079
080  /**
081   * A {@link ClassDesc} describing {@link Iterable}.
082   *
083   * @nullability This field is never {@code null}.
084   */
085  public static final ClassDesc CD_Iterable = ClassDesc.of("java.lang.Iterable");
086
087  /**
088   * A {@link ClassDesc} describing {@link java.util.Optional java.util.Optional}.
089   *
090   * @nullability This field is never {@code null}.
091   */
092  public static final ClassDesc CD_Optional = ClassDesc.of("java.util.Optional");
093
094  /**
095   * A {@link ClassDesc} describing {@link java.util.AbstractMap.SimpleImmutableEntry
096   * java.util.AbstractMap.SimpleImmutableEntry}.
097   *
098   * @nullability This field is never {@code null}.
099   */
100  public static final ClassDesc CD_SimpleImmutableEntry = ClassDesc.of("java.util.AbstractMap$SimpleImmutableEntry");
101
102  /**
103   * A {@link ClassDesc} describing {@link java.util.SortedMap java.util.SortedMap}.
104   *
105   * @nullability This field is never {@code null}.
106   */
107  public static final ClassDesc CD_SortedMap = ClassDesc.of("java.util.SortedMap");
108
109  /**
110   * A {@link ClassDesc} describing {@link java.util.SortedSet java.util.SortedSet}.
111   *
112   * @nullability This field is never {@code null}.
113   */
114  public static final ClassDesc CD_SortedSet = ClassDesc.of("java.util.SortedSet");
115
116  /**
117   * A {@link ClassDesc} describing {@link java.util.TreeMap java.util.TreeMap}.
118   *
119   * @nullability This field is never {@code null}.
120   */
121  public static final ClassDesc CD_TreeMap = ClassDesc.of("java.util.TreeMap");
122
123  /**
124   * A {@link ClassDesc} describing {@link java.util.TreeSet java.util.TreeSet}.
125   *
126   * @nullability This field is never {@code null}.
127   */
128  public static final ClassDesc CD_TreeSet = ClassDesc.of("java.util.TreeSet");
129
130
131  /*
132   * Constructors.
133   */
134
135
136  private ConstantDescs() {
137    super();
138  }
139
140
141}