com.google.cloud.tools.opensource.classpath.Symbol Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dependencies Show documentation

A library for analyzing Maven artifact dependency graphs

There is a newer version: 1.5.13

/*
 * Copyright 2019 Google LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.tools.opensource.classpath;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.base.MoreObjects;

/**
 * The referent of symbolic references (class, method, or field references) in the run-time constant
 * pool of JVM.
 *
 * @see Java
 *     Virtual Machine Specification: The Run-Time Constant Pool
 */
public abstract class Symbol {
  private final String classBinaryName;

  Symbol(String className) {
    this.classBinaryName = checkNotNull(className);
  }

  /**
   * Returns the binary name of the class that contains the symbol. If this is a class symbol, the
   * class name itself.
   *
   * @see Java
   *     Language Specification: 13.1. The Form of a Binary
   */
  public String getClassBinaryName() {
    return classBinaryName;
  }

  @Override
  public abstract boolean equals(Object other);

  @Override
  public abstract int hashCode();

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("className", classBinaryName)
        .toString();
  }
}