001/*
002 * Copyright (C) 2022 - 2024, the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * 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
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.github.ascopes.jct.repr;
017
018import javax.tools.JavaFileManager.Location;
019import org.apiguardian.api.API;
020import org.apiguardian.api.API.Status;
021import org.assertj.core.presentation.Representation;
022import org.jspecify.annotations.Nullable;
023
024/**
025 * Representation for a {@link Location location}.
026 *
027 * @author Ashley Scopes
028 * @since 0.0.1
029 */
030@API(since = "0.0.1", status = Status.STABLE)
031public final class LocationRepresentation implements Representation {
032
033  private static final LocationRepresentation INSTANCE
034      = new LocationRepresentation();
035
036  /**
037   * Get an instance of this location representation.
038   *
039   * @return the instance.
040   */
041  public static LocationRepresentation getInstance() {
042    return INSTANCE;
043  }
044
045  private LocationRepresentation() {
046    // Nothing to see here, move along now.
047  }
048
049  @Override
050  public String toStringOf(@Nullable Object object) {
051    return object == null ? "null" : ((Location) object).getName();
052  }
053}