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 java.util.List;
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 of a {@link List list} of {@link StackTraceElement stack trace frames}.
026 *
027 * @author Ashley Scopes
028 * @since 0.0.1
029 */
030@API(since = "0.0.1", status = Status.STABLE)
031public final class StackTraceRepresentation implements Representation {
032
033  private static final StackTraceRepresentation INSTANCE = new StackTraceRepresentation();
034
035  /**
036   * Get an instance of this stack trace representation.
037   *
038   * @return the instance.
039   */
040  public static StackTraceRepresentation getInstance() {
041    return INSTANCE;
042  }
043
044  private StackTraceRepresentation() {
045    // Nothing to see here, move along now!
046  }
047
048  @Override
049  @SuppressWarnings("unchecked")
050  public String toStringOf(@Nullable Object object) {
051    if (object == null) {
052      return "null";
053    }
054
055    var trace = (List<? extends StackTraceElement>) object;
056    var builder = new StringBuilder("Stacktrace:");
057    for (var frame : trace) {
058      builder.append("\n\tat ").append(frame);
059    }
060    return builder.toString();
061  }
062}