Class PF

  • public class PF
extends java.lang.Object
    Print Flags: Flag-Constants for pretty-printing and selecting output to Reflection API classes' toString(flags) methods.

    This is an example of the output generated by the 'toString(int flags)' methods, when used in conjunction with the flags in this class.

    Field Name: [serialVersionUID] Declaration: [public static final long serialVersionUID = 1;] Type: [long] Definition: [1] Modifiers: [public, static, final] Line Numbers: [sig=22, jdStart=21, jdEnd=21] JD Comments: [/** * <EMBED CLASS="external-html" DATA-FILE-ID="SVUID"> */ ] Method Name: [isTextNode] Signature: [public boolean isTextNode()] Modifiers: [public] Parameter Names: [] Parameter Types: [] Return Type: [boolean] Exceptions: [] Line Numbers: [sig=39, jdStart=32, jdEnd=38] JD Comments: [/** * This method identifies that {@code 'this'} instance of (abstract parent-class) * {@link HTMLNode} is,...] Callable Body: [ return true; ] Constructor Name: [TextNode] Signature: [public TextNode(String s)] Modifiers: [public] Parameter Names: [s] Parameter Types: [java.lang.String] Exceptions: [] Line Numbers: [sig=30, jdStart=24, jdEnd=29] JD Comments: [/** * Constructs a new {@code TextNode} with internal field {@code String str} equal to parameter * {@code ...] Callable Body: [ super(s); ]
    See Also:
    Method.toString(int), Field.toString(int), Constructor.toString(int), EnumConstant.toString(int), AnnotationElem.toString(int)



    Stateless Class:
    This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.

    • 1 Constructor(s), 1 declared private, zero-argument constructor
    • 1 Method(s), 1 declared static
    • 8 Field(s), 8 declared static, 7 declared final
    • Fields excused from final modifier (with explanation):
      Field 'MAX_STR_LEN' is not final. Reason: CONFIGURATION


    • Method Summary

       
      Max String-Length Setter
      Modifier and Type Method
      static void setMaxStrLen​(int maxStrLen)

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • MAX_STR_LEN

        🡇  ⇈  ⮫ 🗕  🗗  🗖 
        protected static int MAX_STR_LEN
        This is the maximum allowed length of lines printed to the output-String

        Thread Un-Safe Configuration:
        This has NOT been declared 'final', and it may be changed to anything you wish, using the setter, setMaxStrLen(int)
        See Also:
        setMaxStrLen(int)
        Code:
        Exact Field Declaration Expression:
         protected static int MAX_STR_LEN = 110;

      • JAVADOC_COMMENTS

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final int JAVADOC_COMMENTS
        This asks the toString() method to include JavaDoc comments in its return-value String
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
         public static final int JAVADOC_COMMENTS = 0b0001;

      • BODY

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final int BODY
        For class Method and class Constructor this flag will tell the toString() method to include the code-body in its return-value String.

        Flag Precedence:
        If both the flags 'BODY' and 'BODY_SHORT' have been applied to a flag-mask, the 'BODY_SHORT' flag is the one that will be heeded, and the other ignored.
        See Also:
        BODY_SHORT, Constant Field Values
        Code:
        Exact Field Declaration Expression:
         public static final int BODY = 0b0010;

      • BODY_SHORT

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final int BODY_SHORT
        For class Method and class Constructor this flag will tell the toString() method to include an abbreviated code-body in its return-value String.

        Flag Precedence:
        If both the flags 'BODY' and 'BODY_SHORT' have been applied to a flag-mask, the 'BODY_SHORT' flag is the one that will be heeded, and the other ignored.
        See Also:
        BODY, Constant Field Values
        Code:
        Exact Field Declaration Expression:
         public static final int BODY_SHORT = 0b0100;

      • UNIX_COLORS

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final int UNIX_COLORS
        This flag will tell the toString(int flags) method to include UNIX Terminal Color Codes in its return-value String.
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
         public static final int UNIX_COLORS = 0b1000;

      • JOW_INSTEAD

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final int JOW_INSTEAD
        Asks that the 'JOW' - Just One Word types to be printed, instead of the complete type-String.

        Note that there are many cases where both the complete type-String and the partial type-String's are actually identical. This is due to a short-coming in the software that has not applied the 'linker' code yet (Java Parser Symbol-Solver). It would add significant time-cost, and add very little to the final Tool's output.

        Flag Precedence:
        If both the flags 'JOW_ALSO' and 'JOW_INSTEAD' have been applied to a flag-mask, the 'JOW_INSTEAD' flag is the one that will be heeded, and the other ignored.
        See Also:
        JOW_ALSO, Constant Field Values
        Code:
        Exact Field Declaration Expression:
         public static final int JOW_INSTEAD = 0b00010000;

      • JOW_ALSO

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final int JOW_ALSO
        Asks that the 'JOW' - Just One Word types to be printed, in addition to the complete type-String.

        Note that there are many cases where both the complete type-String and the partial type-String's are actually identical. This is due to a short-coming in the software that has not applied the 'linker' code yet (Java Parser Symbol-Solver). It would add significant time-cost, and add very little to the final Tool's output.

        Flag Precedence:
        If both the flags 'JOW_ALSO' and 'JOW_INSTEAD' have been applied to a flag-mask, the 'JOW_INSTEAD' flag is the one that will be heeded, and the other ignored.
        See Also:
        JOW_INSTEAD, Constant Field Values
        Code:
        Exact Field Declaration Expression:
         public static final int JOW_ALSO = 0b00100000;

    • Method Detail

      • setMaxStrLen

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static void setMaxStrLen​(int maxStrLen)
        Sets the static configuration field MAX_STR_LEN.

        Thread Un-Safe Configuration:
        This sets a static internal field, and it's value will, therefore, be reflected across all threads, not just the one in use.
        See Also:
        MAX_STR_LEN
        Code:
        Exact Method Body:
         if (maxStrLen < 10) throw new IllegalArgumentException
     ("maxStrLen may only be set to a number greater than 10");

 MAX_STR_LEN = maxStrLen;