Package cdc.issues.rules

Class RuleDescription

java.lang.Object

cdc.issues.StructuredDescription

cdc.issues.rules.RuleDescription

public class RuleDescription
extends StructuredDescription

Specialization of StructuredDescription that can be used to describe a Rule.

It supports the following sections:

• Remarks that can be used to add remarks.
• Sources that can be used to refer to related sources.
• Applies to that can be used to designate things to which the rule can be applied.
• Exceptions that can be used to designate exceptions to the rule.
• Related to that can be used to create link with other rules.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RuleDescription.Builder<B extends RuleDescription.Builder<B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A
static final String	ALL
static final String	AN
static final String	ANY
static final String	SECTION_APPLIES_TO
static final String	SECTION_EXCEPTIONS
static final String	SECTION_RELATED_TO
static final String	SECTION_REMARKS
static final String	SECTION_SOURCES
static final String	SOME
static final String	THE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RuleDescription(RuleDescription.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
static RuleDescription.Builder<?>	builder()
static String	format(String format, Object... args)	Formats a list of arguments with a format.
static String	wrap(String item)
static String	wrap(String article, boolean capital, String item)

Methods inherited from class cdc.issues.StructuredDescription

getHeader, getSectionContent, getSectionItems, getSections, getText, hasSection, toString

Methods inherited from class java.lang.Object

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

Field Details

SECTION_APPLIES_TO

public static final String SECTION_APPLIES_TO

See Also:

• Constant Field Values

SECTION_EXCEPTIONS

public static final String SECTION_EXCEPTIONS

See Also:

• Constant Field Values

SECTION_REMARKS

public static final String SECTION_REMARKS

See Also:

• Constant Field Values

SECTION_RELATED_TO

public static final String SECTION_RELATED_TO

See Also:

• Constant Field Values

SECTION_SOURCES

public static final String SECTION_SOURCES

See Also:

• Constant Field Values

A

public static final String A

See Also:

• Constant Field Values

AN

public static final String AN

See Also:

• Constant Field Values

ANY

public static final String ANY

See Also:

• Constant Field Values

SOME

public static final String SOME

See Also:

• Constant Field Values

THE

public static final String THE

See Also:

• Constant Field Values

ALL

public static final String ALL

See Also:

• Constant Field Values

Constructor Details

RuleDescription

protected RuleDescription(RuleDescription.Builder<?> builder)

Method Details

format

public static String format(String format,
 Object... args)

Formats a list of arguments with a format.

The following format specifiers are supported:

• wrap: the passed argument is wrapped with '[' and ']'.
• lower: if the passed argument is null, nothing is inserted, otherwise a space followed by the passed argument converted to lower case is inserted.
• capital: if the passed argument is null, nothing is inserted, otherwise a space followed by the passed argument converted to capital case is inserted.

Examples:

• format("Foo{%lower}Bar", null) = "FooBar"
• format("Foo{%lower}Bar", "AA") = "Foo aaBar"
• format("Foo{%wrap}Bar", "AA") = "Foo[AA]Bar"

Parameters:

format - The format string.

args - The arguments.

Returns:

A string formatted for format and args.

wrap

public static String wrap(String item)

wrap

public static String wrap(String article,
 boolean capital,
 String item)

builder

public static RuleDescription.Builder<?> builder()