Class StaticSiteTemplateOptions


  • public final class StaticSiteTemplateOptions
    extends Object
    Template Options for the static site.
    • Constructor Detail

      • StaticSiteTemplateOptions

        public StaticSiteTemplateOptions()
    • Method Detail

      • templateRepositoryUrl

        public String templateRepositoryUrl()
        Get the templateRepositoryUrl property: URL of the template repository. The newly generated repository will be based on this one.
        Returns:
        the templateRepositoryUrl value.
      • withTemplateRepositoryUrl

        public StaticSiteTemplateOptions withTemplateRepositoryUrl​(String templateRepositoryUrl)
        Set the templateRepositoryUrl property: URL of the template repository. The newly generated repository will be based on this one.
        Parameters:
        templateRepositoryUrl - the templateRepositoryUrl value to set.
        Returns:
        the StaticSiteTemplateOptions object itself.
      • owner

        public String owner()
        Get the owner property: Owner of the newly generated repository.
        Returns:
        the owner value.
      • withOwner

        public StaticSiteTemplateOptions withOwner​(String owner)
        Set the owner property: Owner of the newly generated repository.
        Parameters:
        owner - the owner value to set.
        Returns:
        the StaticSiteTemplateOptions object itself.
      • repositoryName

        public String repositoryName()
        Get the repositoryName property: Name of the newly generated repository.
        Returns:
        the repositoryName value.
      • withRepositoryName

        public StaticSiteTemplateOptions withRepositoryName​(String repositoryName)
        Set the repositoryName property: Name of the newly generated repository.
        Parameters:
        repositoryName - the repositoryName value to set.
        Returns:
        the StaticSiteTemplateOptions object itself.
      • description

        public String description()
        Get the description property: Description of the newly generated repository.
        Returns:
        the description value.
      • withDescription

        public StaticSiteTemplateOptions withDescription​(String description)
        Set the description property: Description of the newly generated repository.
        Parameters:
        description - the description value to set.
        Returns:
        the StaticSiteTemplateOptions object itself.
      • isPrivate

        public Boolean isPrivate()
        Get the isPrivate property: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
        Returns:
        the isPrivate value.
      • withIsPrivate

        public StaticSiteTemplateOptions withIsPrivate​(Boolean isPrivate)
        Set the isPrivate property: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
        Parameters:
        isPrivate - the isPrivate value to set.
        Returns:
        the StaticSiteTemplateOptions object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.