CLPApplicationConfigurationType.java

/*
 * Copyright © 2020 Mark Raynsford <code@io7m.com> http://io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.claypot.core;

import com.io7m.immutables.styles.ImmutablesStyleType;
import org.immutables.value.Value;
import org.slf4j.Logger;

import java.net.URI;
import java.util.List;
import java.util.Optional;

/**
 * The application configuration.
 */

@ImmutablesStyleType
@Value.Immutable
public interface CLPApplicationConfigurationType
{
  /**
   * @return The logger used for command-line messages
   */

  Logger logger();

  /**
   * @return The name of the application
   */

  String programName();

  /**
   * @return The URI of any documentation for the application
   */

  Optional<URI> documentationURI();

  /**
   * @return The list of commands
   */

  List<CLPCommandConstructorType> commands();
}