com.xilinx.rapidwright.util

Class MessageGenerator

Object

com.xilinx.rapidwright.util.MessageGenerator

public class MessageGenerator
extends Object

Common class for generating messages.

Constructor Summary

Constructors

Constructor and Description
MessageGenerator()

Method Summary

Modifier and Type	Method and Description
static void	agreeToContinue() This will prompt the user to type y or n to either continue with a process or to exit.
static void	briefError(String msg) Used as a general way to create an error message and send it to std.err.
static void	briefMessage(String msg) Used as a general way to create a message and send it to std.out.
static String	createStringFromArray(Object[] objs) Creates a simple string from an array of objects.
static String	formatString(String s1)
static String	formatString(String s, boolean value)
static String	formatString(String s, float value)
static String	formatString(String s, int value)
static String	formatString(String s, long value)
static String	formatString(String s, short value)
static void	generalError(String msg) Used as a general way to create an error message and send it to std.err.
static void	generalErrorAndExit(String msg) Used as a general way to create an error message and send it to std.err.
static void	printHeader(String s) Prints a generic header to standard out to separate operations.
static void	promptToContinue() This will prompt the user to type y or n to either continue with a process or to exit.
static void	waitOnAnyKey() Prompts the user to press any key to continue execution.
static void	waitOnAnyKeySilent() Pauses execution until a key is pressed.

Methods inherited from class Object

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

Constructor Detail

MessageGenerator

public MessageGenerator()

Method Detail

generalErrorAndExit

public static void generalErrorAndExit(String msg)

Used as a general way to create an error message and send it to std.err. Prints the stack trace from this point and exits the program.

Parameters:

msg - The message to print to standard error

generalError

public static void generalError(String msg)

Used as a general way to create an error message and send it to std.err. Prints the stack trace from this point.

Parameters:

msg - The message to print to standard error

briefError

public static void briefError(String msg)

Used as a general way to create an error message and send it to std.err.

Parameters:

msg - The message to print to standard error

briefMessage

public static void briefMessage(String msg)

Used as a general way to create a message and send it to std.out.

Parameters:

msg - The message to print to standard out

waitOnAnyKey

public static void waitOnAnyKey()

Prompts the user to press any key to continue execution.

waitOnAnyKeySilent

public static void waitOnAnyKeySilent()

Pauses execution until a key is pressed.

createStringFromArray

public static String createStringFromArray(Object[] objs)

Creates a simple string from an array of objects. This method calls the toString() on each object in the array.

Parameters:

objs - The object to create a string from.

Returns:

A string of all the objects toStrings() concatenated with spaces in between.

printHeader

public static void printHeader(String s)

Prints a generic header to standard out to separate operations.

Parameters:

s -

promptToContinue

public static void promptToContinue()

This will prompt the user to type y or n to either continue with a process or to exit.

agreeToContinue

public static void agreeToContinue()

This will prompt the user to type y or n to either continue with a process or to exit.

formatString

public static String formatString(String s1)

formatString

public static String formatString(String s,
                                  float value)

formatString

public static String formatString(String s,
                                  short value)

formatString

public static String formatString(String s,
                                  boolean value)

formatString

public static String formatString(String s,
                                  int value)

formatString

public static String formatString(String s,
                                  long value)