net.steppschuh.markdowngenerator.progress

Class ProgressBar

java.lang.Object

net.steppschuh.markdowngenerator.MarkdownElement

net.steppschuh.markdowngenerator.progress.ProgressBar

All Implemented Interfaces:

MarkdownSerializable

public class ProgressBar
extends MarkdownElement

Created by Stephan on 12/18/2016.

Field Summary

Fields

Modifier and Type	Field and Description
static char	CLOSING_CHAR_DEFAULT
static char	EMPTY_CHAR_DEFAULT
static char	FILL_CHAR_DEFAULT
static int	LENGTH_LARGE
static int	LENGTH_NORMAL
static int	LENGTH_SMALL
static char	OPENING_CHAR_DEFAULT

Constructor Summary

Constructors

Constructor and Description
ProgressBar(double value)
ProgressBar(double value, int length)

Method Summary

Modifier and Type	Method and Description
static int	calculateFilledCharsCount(double value, double minimumValue, double maximumValue, int length)
char	getClosingChar()
char	getEmptyChar()
char	getFillChar()
int	getLength()
double	getMaximumValue()
double	getMinimumValue()
char	getOpeningChar()
static java.lang.String	getReadablePercentage(double value, double minimumValue, double maximumValue)
static java.lang.String	getReadableValue(double value)
double	getValue()
boolean	isAppendingPercentage()
boolean	isAppendingValue()
java.lang.String	serialize() Attempts to generate a String representing this markdown element.
void	setAppendPercentage(boolean appendPercentage)
void	setAppendValue(boolean appendValue)
void	setClosingChar(char closingChar)
void	setEmptyChar(char emptyChar)
void	setFillChar(char fillChar)
void	setLength(int length)
void	setMaximumValue(double maximumValue)
void	setMinimumValue(double minimumValue)
void	setOpeningChar(char openingChar)
void	setValue(double value)

Methods inherited from class net.steppschuh.markdowngenerator.MarkdownElement

getSerialized, getSerialized, invalidateSerialized, setSerialized, toMarkdownElement, toString

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH_SMALL

public static final int LENGTH_SMALL

See Also:

Constant Field Values

LENGTH_NORMAL

public static final int LENGTH_NORMAL

See Also:

Constant Field Values

LENGTH_LARGE

public static final int LENGTH_LARGE

See Also:

Constant Field Values

OPENING_CHAR_DEFAULT

public static final char OPENING_CHAR_DEFAULT

See Also:

Constant Field Values

CLOSING_CHAR_DEFAULT

public static final char CLOSING_CHAR_DEFAULT

See Also:

Constant Field Values

FILL_CHAR_DEFAULT

public static final char FILL_CHAR_DEFAULT

See Also:

Constant Field Values

EMPTY_CHAR_DEFAULT

public static final char EMPTY_CHAR_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ProgressBar

public ProgressBar(double value)

ProgressBar

public ProgressBar(double value,
                   int length)

Method Detail

serialize

public java.lang.String serialize()
                           throws MarkdownSerializationException

Description copied from class: MarkdownElement

Attempts to generate a String representing this markdown element.

Specified by:

serialize in class MarkdownElement

Returns:

Markdown as String

Throws:

MarkdownSerializationException - If unable to generate a markdown String

calculateFilledCharsCount

public static int calculateFilledCharsCount(double value,
                                            double minimumValue,
                                            double maximumValue,
                                            int length)

getReadableValue

public static java.lang.String getReadableValue(double value)

getReadablePercentage

public static java.lang.String getReadablePercentage(double value,
                                                     double minimumValue,
                                                     double maximumValue)

getOpeningChar

public char getOpeningChar()

setOpeningChar

public void setOpeningChar(char openingChar)

getClosingChar

public char getClosingChar()

setClosingChar

public void setClosingChar(char closingChar)

getFillChar

public char getFillChar()

setFillChar

public void setFillChar(char fillChar)

getEmptyChar

public char getEmptyChar()

setEmptyChar

public void setEmptyChar(char emptyChar)

getLength

public int getLength()

setLength

public void setLength(int length)

getValue

public double getValue()

setValue

public void setValue(double value)

getMinimumValue

public double getMinimumValue()

setMinimumValue

public void setMinimumValue(double minimumValue)

getMaximumValue

public double getMaximumValue()

setMaximumValue

public void setMaximumValue(double maximumValue)

isAppendingValue

public boolean isAppendingValue()

setAppendValue

public void setAppendValue(boolean appendValue)

isAppendingPercentage

public boolean isAppendingPercentage()

setAppendPercentage

public void setAppendPercentage(boolean appendPercentage)