Package boozilla.houston.gradle

Class HoustonEnvironment

java.lang.Object
boozilla.houston.gradle.HoustonEnvironment
public abstract class HoustonEnvironment extends Object
The HoustonEnvironment class represents a Houston environment configuration.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_PATH
    The DEFAULT_PATH constant specifies the default file path for assets.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HoustonEnvironment(String name)
    Constructs a new HoustonEnvironment object with the given name.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Returns the name of the object.
    abstract org.gradle.api.provider.Property<String>
    getPath()
    Retrieves the path of the token.
    abstract org.gradle.api.provider.Property<String>
    getScope()
    Gets the scope of the authorization.
    String
    getTaskName(String taskName)
    Retrieves the task name by concatenating the name of the object and the provided task name.
    abstract org.gradle.api.provider.Property<Boolean>
    getTls()
    Returns the value indicating whether the TLS (Transport Layer Security) protocol should be used or not.
    abstract org.gradle.api.provider.Property<String>
    getToken()
    Gets the token used for authentication.
    abstract org.gradle.api.provider.Property<String>
    getUrl()
    Retrieves the URL property for the Houston environment.
    abstract org.gradle.api.provider.Property<org.gradle.api.Project>
    getVerifier()
    Retrieves the verifier property for the Houston environment.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_PATH

      public static final String DEFAULT_PATH
      The DEFAULT_PATH constant specifies the default file path for assets.

      The path is set to "src/asset" by default. This path should be used when accessing or saving asset files in the application.

      See Also:

  • Constructor Details

    • HoustonEnvironment

      @Inject public HoustonEnvironment(String name)
      Constructs a new HoustonEnvironment object with the given name.
      Parameters:
      name - the name of the Houston environment

  • Method Details

    • getUrl

      @Input public abstract org.gradle.api.provider.Property<String> getUrl()
      Retrieves the URL property for the Houston environment.
      Returns:
      The URL property as a Property object.

    • getToken

      @Input public abstract org.gradle.api.provider.Property<String> getToken()
      Gets the token used for authentication.
      Returns:
      The token as a String object.

    • getScope

      @Input public abstract org.gradle.api.provider.Property<String> getScope()
      Gets the scope of the authorization.
      Returns:
      The scope as a String object.

    • getPath

      @Input public abstract org.gradle.api.provider.Property<String> getPath()
      Retrieves the path of the token.
      Returns:
      the path of the token

    • getTls

      @Input public abstract org.gradle.api.provider.Property<Boolean> getTls()
      Returns the value indicating whether the TLS (Transport Layer Security) protocol should be used or not.
      Returns:
      The property representing the flag indicating if TLS should be used.

    • getVerifier

      @Input public abstract org.gradle.api.provider.Property<org.gradle.api.Project> getVerifier()
      Retrieves the verifier property for the Houston environment.
      Returns:
      The verifier property as a Property object representing the verifier for the Houston environment.

    • getName

      public String getName()
      Returns the name of the object.
      Returns:
      the name of the object

    • getTaskName

      public String getTaskName(String taskName)
      Retrieves the task name by concatenating the name of the object and the provided task name.
      Parameters:
      taskName - the name of the task
      Returns:
      the concatenated task name