001/*
002 * Copyright (C) 2022 - 2023, 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.containers;
017
018import javax.tools.JavaFileManager.Location;
019import org.apiguardian.api.API;
020import org.apiguardian.api.API.Status;
021
022/**
023 * A base definition for an output-oriented container group.
024 *
025 * <p>These can behave as if they are module-oriented, or non-module-oriented.
026 * It is down to the implementation to mediate access between modules and their files.
027 *
028 * <p>Operations on modules should first {@link #getModule(String) get} or
029 * {@link #getOrCreateModule(String) create} the module, and then operate on that sub-container
030 * group. Operations on non-module packages should operate on this container group directly.
031 *
032 * @author Ashley Scopes
033 * @since 0.0.1
034 */
035@API(since = "0.0.1", status = Status.STABLE)
036public interface OutputContainerGroup extends PackageContainerGroup, ModuleContainerGroup {
037
038  /**
039   * Get the output-oriented location.
040   *
041   * @return the output-oriented location.
042   */
043  @Override
044  Location getLocation();
045}