GrailsBanner (Grails 7.1.0-SNAPSHOT)

grails.boot.GrailsBanner

All Implemented Interfaces and Traits:: Banner

@groovy.transform.CompileStatic
@groovy.transform.MapConstructor(noArg: true)
class GrailsBanner
extends java.lang.Object
implements Banner

The default Grails application banner.

Since:: 7.1

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`GrailsBanner.DefaultVersionFormatter`	The default implementation of the VersionsFormatter.
`static enum`	`GrailsBanner.DefaultVersionOption`	Enumeration of default version options.
`static enum`	`GrailsBanner.OptionalVersionOption`	Enumeration of optional version options.
`static enum`	`GrailsBanner.VersionOption`	Enumeration of supported version options.
`interface`	`GrailsBanner.VersionsFormatter`	Strategy interface for formatting version information into printable lines.

Properties Summary

Properties
Type	Name and description
`int`	`artPaddingBottom`
`java.lang.String`	`bannerFile`
`int`	`bannerPaddingBottom`
`int`	`bannerPaddingTop`

Constructor Summary

Constructors
Constructor and description
`GrailsBanner()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.String`	`createBannerArt(Environment environment)` Creates the banner art to be displayed.
	`protected java.util.Map<java.lang.String, java.lang.String>`	`createBannerVersions(Environment env)` Creates a map of versions to be displayed in the banner.
	`protected GrailsBanner.VersionsFormatter`	`createVersionsFormatter()` Creates the versions formatter to format the version information.
	`void`	`printBanner(Environment environment, java.lang.Class<?> sourceClass, java.io.PrintStream out)` Prints the banner to the specified PrintStream.
	`protected boolean`	`shouldDisplayArt(Environment env)` Determines whether to display the banner art.
	`protected boolean`	`shouldDisplayVersions(Environment env)` Determines whether to display the version information.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Property Detail
  - int artPaddingBottom
  - java.lang.String bannerFile
  - int bannerPaddingBottom
  - int bannerPaddingTop
- Constructor Detail
  - GrailsBanner()
- Method Detail
  - protected java.lang.String createBannerArt(Environment environment)
    
    Creates the banner art to be displayed.
    Parameters:
    environment - the current environment
    Returns:
    the banner art
  - @java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
    protected java.util.Map<java.lang.String, java.lang.String> createBannerVersions(Environment env)
    
    Creates a map of versions to be displayed in the banner.
    Parameters:
    env - the current env
    Returns:
    a map of version labels to version values
  - protected GrailsBanner.VersionsFormatter createVersionsFormatter()
    
    Creates the versions formatter to format the version information.
    Returns:
    the versions formatter
  - @java.lang.Override
    void printBanner(Environment environment, java.lang.Class<?> sourceClass, java.io.PrintStream out)
    
    Prints the banner to the specified PrintStream.
    Parameters:
    environment - the current environment
    sourceClass - the source class
    out - the PrintStream to print to
  - @java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
    protected boolean shouldDisplayArt(Environment env)
    
    Determines whether to display the banner art.
    Parameters:
    env - the current environment
    Returns:
    true if the banner art should be displayed, false otherwise
  - @java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
    protected boolean shouldDisplayVersions(Environment env)
    
    Determines whether to display the version information.
    Parameters:
    env - the current environment
    Returns:
    true if the version information should be displayed, false otherwise

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class GrailsBanner

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

int artPaddingBottom

java.lang.String bannerFile

int bannerPaddingBottom

int bannerPaddingTop

Constructor Detail

GrailsBanner()

Method Detail

protected java.lang.String createBannerArt(Environment environment)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
protected java.util.Map<java.lang.String, java.lang.String> createBannerVersions(Environment env)

protected GrailsBanner.VersionsFormatter createVersionsFormatter()

@java.lang.Override
void printBanner(Environment environment, java.lang.Class<?> sourceClass, java.io.PrintStream out)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
protected boolean shouldDisplayArt(Environment env)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
protected boolean shouldDisplayVersions(Environment env)

[Groovy] Class GrailsBanner

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

int artPaddingBottom

java.lang.String bannerFile

int bannerPaddingBottom

int bannerPaddingTop

Constructor Detail

GrailsBanner()

Method Detail

protected java.lang.String createBannerArt(Environment environment)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)protected java.util.Map<java.lang.String, java.lang.String> createBannerVersions(Environment env)

protected GrailsBanner.VersionsFormatter createVersionsFormatter()

@java.lang.Overridevoid printBanner(Environment environment, java.lang.Class<?> sourceClass, java.io.PrintStream out)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)protected boolean shouldDisplayArt(Environment env)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)protected boolean shouldDisplayVersions(Environment env)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
protected java.util.Map<java.lang.String, java.lang.String> createBannerVersions(Environment env)

@java.lang.Override
void printBanner(Environment environment, java.lang.Class<?> sourceClass, java.io.PrintStream out)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
protected boolean shouldDisplayArt(Environment env)

@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
protected boolean shouldDisplayVersions(Environment env)