Class Rainbow

This class contains all the methods implementation documentation.

Since

1.0.0

Package org.techous.rainbow
class  Rainbow
extends  java.lang.Object
implements Procedures

Constructors

Rainbow ( )

public Rainbow( )

This function will create a colors mapping that you need for getting different colors.

Methods

get( value )

public java.lang.String get( java.lang.String value )

this function will return the all the rainbow combinations

Parameters:

For value parameter you can see available FORMATS, COLORS and BACKGROUNDS

Returns:

Rainbowed codes

getFormat( format )

public java.lang.String getFormat( java.lang.String format )

Returns the format code you need to change the string format

Parameters:

For format parameter you can see available FORMATS.

Returns:

formatted code

getColor( color )

public java.lang.String getColor( java.lang.String color )

Returns the color code for changing text to colored text

Parameters:

For color parameter you can see available COLORS.

Returns:

color codes

getBG( background )

public java.lang.String getBG( java.lang.String background )

Returns the colored background code for coloring backgrounds

Parameters:

background --> you can see available BACKGROUND docs.

Returns:

background color codes

getFormatColor( format, color )

public java.lang.String getFormatColor( java.lang.String format, java.lang.string color )

this function will return the formatted color code

Parameters:

For format and color parameters you can see available FORMATS and COLORS.

Returns:

formatted color code

getFormatBG( format, background )

public java.lang.String getFormatBG( java.lang.String format, java.lang.string background )

this function will return formatted background code

Parameters:

For format and background parameters you can see available FORMATS and BACKGROUNDS.

Returns:

formatted background code

getColorBG( color, background )

public java.lang.String getColorBG( java.lang.String color, java.lang.string background )

this function will return colored background code

Parameters:

For color and background parameters you can see available COLORS and BACKGROUNDS.

Returns:

colored bacground code

getRainbow( format, color, background )

public java.lang.String getRainbow( java.lang.String format, java.lang.String color, java.lang.string background )

this function will return rainbowed code

Parameters:

For format, color and background parameters you can see available FORMATS, COLORS and BACKGROUNDS.

Returns:

rainbowed code

getFormatString( format, str, end )

public java.lang.String getFormatString( java.lang.String format, java.lang.String str, boolean end )

This function will generate the formatted string according to the format passed

Parameters:

format --> you can see available FORMAT docs.

str --> is the string to be formatted

end --> is whether to end the color coding or not

Returns:

formatted string

getColorString( color, str, end )

public java.lang.String getColorString( java.lang.String color, java.lang.String str, boolean end )

This function will generate the colored string according to the color passed

Parameters:

color --> you can see available COLOR docs.

str --> is the string to be formatted

end --> is whether to end the color coding or not

Returns:

color codes

getBGString( background, str, end )

public java.lang.String getBGString( java.lang.String background, java.lang.String str, boolean end )

This function will generate the filled background string according to the background passed

Parameters:

background --> you can see available BACKGROUND docs.

str --> is the string to be colored

end --> is whether to end the color coding or not

Returns:

filled background string

getFormatColorString( format, color, str, end )

public java.lang.String getFormatColorString( java.lang.String format, java.lang.String color, java.lang.String str, boolean end )

this function will return the formatted colored string

Parameters:

format --> you can see available FORMAT docs.

color --> you can see available COLOR docs.

str --> is the string to be colored

end --> is whether to end the color coding or not

Returns:

formatted color string

getFormatBGString( format, background, str, end )

public java.lang.String getFormatBGString( java.lang.String format, java.lang.String background, java.lang.String str, boolean end )

this function will return formatted background string

Parameters:

format --> you can see available FORMAT docs.

background --> you can see available BACKGROUND docs.

str --> is the string to be colored

end --> is whether to end the color coding or not

Returns:

formatted background string

getColorBGString( color, background, str, end )

public java.lang.String getColorBGString( java.lang.String color, java.lang.string background, java.lang.String str, boolean end )

this function will return colored background string

Parameters:

color --> you can see available COLOR docs.

background --> you can see available BACKGROUND docs.

str --> is the string to be colored

end --> is whether to end the color coding or not

Returns:

colored bacground string

getRainbowString( format, color, background, str, end )

public java.lang.String getRainbowString( java.lang.String format, java.lang.String color, java.lang.string background, java.lang.String str, boolean end )

this function will return rainbowed string

Parameters:

format --> you can see available FORMAT docs.

color --> you can see available COLOR docs.

background --> you can see available BACKGROUND docs.

str --> is the string to be colored

end --> is whether to end the color coding or not

Returns:

rainbowed string