Class Convenience


  • public class Convenience
    extends java.lang.Object
    Process Java Doc Web-Page: Replace documentation-HTML for overloaded Methods & Constructors tagged with the key-word 'Convenience'.

    JD-Upgrader Internally Used Class, Methods are Package-Private

    There is largely no use for these methods outside of the Java Doc Upgrader Application. Little Java-Doc Style Documentation will be provided here. The code itself (and code comments) may be viewed using the HiLited Source Code Button in the Navigation-Bar, or the URL-Link that is lower on this page.

    To see how this Upgrader Application class works, click the HiLited Source Code Link above.

    The Upgrader Tool "keeps an eye out" for any methods whose Java-Doc descriptions begin with the sub-string "Convenience Method" or "Convenience Constructor". When one is found, a few check are performed to ensure that the generated description is kept simplified according to the standard pattern for "Convenience Methods" (and Constructors) on an Upgraded Java-Doc Documentation Web-Page.

    NOTE: Convenience Methods are simple, only having one or two lines in the body. Often they simply provide default values for parameters that the user ought not to have to bother with in many of the use-cases of another method. They are, invariably, used for methods (and somtimes constructors) that are overloaded in order to simplify the naming conventions that users of the A.P.I. have to face.

    Convenience Example Use


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 field. It is very similar to the Java-Bean @Stateless Annotation.
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 2 Method(s), 2 declared static
  • 5 Field(s), 5 declared static, 5 declared final


    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • CONVENIENCE_METHOD_CSS_CLASS

        🡇    
        public static final java.lang.String CONVENIENCE_METHOD_CSS_CLASS
        This is the CSS Class that's insert into method's that have been tagged as "Convenience Methods"

        Such a method may be specified by placing the Exact-String 'Convenience Method.' (including the ending period) on the first line of a Java Doc Comment.

        After processing by this Upgrade Tool, the Details-HTML for that method will resemble:

        Convenience Method Ex.
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final String CONVENIENCE_METHOD_CSS_CLASS = "CNVMETHOD";
        
      • CONVENIENCE_CTOR_CSS_CLASS

        🡅    
        public static final java.lang.String CONVENIENCE_CTOR_CSS_CLASS
        This is the CSS Class that's inserted into constructor's that have been tagged as "Convenience Constructors"

        Such a constructor may be specified by placing the Exact-String 'Convenience Constructor.' (including the ending period) on the first line of a Java Doc Comment.

        After processing by this Upgrade Tool, the Details-HTML for that constructor will resemble:

        Constructor Example
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        public static final String CONVENIENCE_CTOR_CSS_CLASS = "CNVCTOR";