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.assertions;
017
018import static org.assertj.core.api.Assertions.assertThat;
019
020import io.github.ascopes.jct.filemanagers.PathFileObject;
021import org.assertj.core.api.AbstractPathAssert;
022import org.jspecify.annotations.Nullable;
023
024/**
025 * Assertions for {@link PathFileObject Path file objects}.
026 *
027 * @author Ashley Scopes
028 * @since 0.0.1
029 */
030public final class PathFileObjectAssert
031    extends AbstractJavaFileObjectAssert<PathFileObjectAssert, PathFileObject> {
032
033  /**
034   * Create a new instance of this assertion object.
035   *
036   * @param actual the path file object to assert upon.
037   */
038  public PathFileObjectAssert(@Nullable PathFileObject actual) {
039    super(actual, PathFileObjectAssert.class);
040  }
041
042  /**
043   * Perform an assertion on the file object's relative path.
044   *
045   * <p>The path is relative to the base directory holding all the
046   * sources relative to their package names.
047   *
048   * @return the assertions for the path.
049   * @throws AssertionError if the file object is null.
050   */
051  public AbstractPathAssert<?> relativePath() {
052    isNotNull();
053
054    return assertThat(actual.getRelativePath());
055  }
056
057  /**
058   * Perform an assertion on the file object's absolute path.
059   *
060   * <p>You generally should prefer using {@link #relativePath}.
061   *
062   * @return the assertions for the path.
063   * @throws AssertionError if the file object is null.
064   */
065  public AbstractPathAssert<?> absolutePath() {
066    isNotNull();
067
068    return assertThat(actual.getAbsolutePath());
069  }
070}