hibernate

Hibernate example to starting up

This spring-boot application will show some hibernate principles. Just for starting you up and understand how it works.

Additionally I will show you how to use doclet (skip reading below info if you don't need it).

Below documentation was copied from initial source

for JDK 1.9 and higher see source

UML Doclet Usage

Usage

This page describes how to use the UML Doclet together with the Oracle JavaDoc tool to generate standard HTML documentation for your project, with PlantUML source files for each Java class and package.

Gradle

In gradle, the doclet and its dependency need to be declared. From there on, the configuration is the same as your regular JavaDoc configuration.

plugins {
    id 'java'
}

configurations {
    umlDoclet
}

dependencies {
    ...
    ...
    umlDoclet "nl.talsmasoftware:umldoclet:1.1.4" //support jdk 1.8, for higher use 2.x
}

javadoc {
    source = sourceSets.main.allJava
    options.author = true
    options.showAll()
    options.docletpath = configurations.umlDoclet.files.asType(List)
    options.doclet('nl.talsmasoftware.umldoclet.UMLDoclet')
    options.tags = [
            'plantuml.domainModuleName:t:PlantUml domain:',
            'plantuml.skip:tcmf',
            'note:t'
    ]
    options.addStringOption('umlIncludeConstructors', 'true')
    options.addStringOption('umlIncludePublicFields', 'true')
    options.addStringOption('umlIncludePrivateFields', 'true')
    options.addStringOption('umlIncludeProtectedFields', 'true')
    options.addStringOption('additionalParamName', 'additionalParamValue')

    failOnError false  // if you needed!
}

Tags:

• @plantuml.domainModuleName Descriptor -> for domains
• @plantuml.skip for skipping in javadoc

Reqired additional doclet extended class. Official documentation how to made that.

Replace additionalParamName and additionalParamValue with the name and value of each additional parameter you need.
Note: The initial dash - of additional parameters will automatically be added by the Gradle javadoc task and should therefore be omitted from the configuration.

The additional parameters for this doclet are described below.

Additional parameters

The UML Doclet supports many additional parameters to be configured.
However, please know that all attempts have been made to keep the defaults chosen in such a manner, that the options rarely need to be overridden. If you happen to come accross badly chosen default parameters, please let me know by filing a new issue.

Parameter name + Possible values	Default value	Description
-umlLogLevel ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL	INFO	The log level defined in common level definitions
-umlIndentation integer	-1	The indentation level to use for the generated UML. A negative value uses whatever the default indentation is and zero obviously will not indent the UML.
-umlBasePath filesystem path	<null>	The base path where the UML diagrams should be generated, by default the UML Doclet generates the diagrams in the same location as the regular HTML documentation.
-umlFileExtension file extention	".puml"	The file extension to use for generated UML diagrams.
-umlFileEncoding encoding name	"UTF-8"	The file encoding to use for generated UML diagrams. Note however, before the default value is applied, the standard doclet option -docEncoding is inspected to obtain a value.
-umlSkipStandardDoclet boolean	false	When set to true this option prevents the UML Doclet from delegating to the Standard doclet that generates the HTML documentation.
-umlIncludePrivateFields boolean	false	Whether private fields will be included in the rendered diagrams.
-umlIncludePackagePrivateFields boolean	false	Whether package-private fields will be included in the rendered diagrams.
-umlIncludeProtectedFields boolean	true	Whether protected fields will be included in the rendered diagrams.
-umlIncludePublicFields boolean	true	Whether public fields will be included in the rendered diagrams.
-umlIncludeDeprecatedFields boolean	false	Whether deprecated fields will be included in the rendered diagrams.
-umlIncludeFieldTypes boolean	true	Whether the field types will be included in the rendered diagrams.
-umlIncludeMethodParamNames boolean	false	Whether the names of method parameters will be included in the rendered diagrams.
-umlIncludeMethodParamTypes boolean	true	Whether the types of method parameters will be included in the rendered diagrams.
-umlIncludeMethodReturntypes boolean	true	Whether the returntypes of methods will be included in the rendered diagrams.
-umlIncludeConstructors boolean	true	Whether the class constructors will be included in the rendered diagrams.
-umlIncludeDefaultConstructors boolean	false	(only applicable when -umlIncludeConstructors is true) Whether the class constructors will still be included in the rendered diagrams if the only constructor is the default constructor without parameters.
-umlIncludePrivateMethods boolean	false	Whether private methods will be included in the rendered diagrams.
-umlIncludePackagePrivateMethods boolean	false	Whether package-private methods will be included in the rendered diagrams.
-umlIncludeProtectedMethods boolean	true	Whether protected methods will be included in the rendered diagrams.
-umlIncludePublicMethods boolean	true	Whether public methods will be included in the rendered diagrams.
-umlIncludeDeprecatedMethods boolean	false	Whether deprecated methods will be included in the rendered diagrams.
-umlIncludeAbstractSuperclassMethods boolean	true	Whether abstract methods will be included in superclasses, even when declared outside the rendered package.
-umlIncludePrivateClasses boolean	false	Whether private classes will be included in the rendered package diagrams.
-umlIncludePackagePrivateClasses boolean	false	Whether package-private classes will be included in the rendered package diagrams.
-umlIncludeProtectedClasses boolean	true	Whether protected classes will be included in the rendered package diagrams.
-umlIncludeDeprecatedClasses boolean	false	Whether deprecated classes will be included in the rendered package diagrams.
-umlIncludePrivateInnerClasses boolean	false	Whether private inner-classes will be included in the rendered diagrams.
-umlIncludePackagePrivateInnerClasses boolean	false	Whether package-private inner-classes will be included in the rendered diagrams.
-umlIncludeProtectedInnerClasses boolean	false	Whether protected inner-classes will be included in the rendered diagrams.
-umlExcludedReferences list of classes	Standard java Object, Enum, Annotation	List of classes that will not be rendered as an external reference in the diagrams. Please mind that this value must be enclosed in quotes or there should be no spaces in this setting for the JavaDoc tool to be able to parse this as a single value.
-umlIncludeOverridesFromExcludedReferences boolean	false	Whether inherited methods from classes defined in -umlExcludedReferences should be rendered in the diagrams.
-umlCommand commands	none	This setting allows custom commands to be added to the diagrams. Commands containing whitespaces must be provided within double-quotes. Multiple commands can be specified by specifying the -umlCommand parameter repeatedly. An example value could be a -umlCommand "hide class circle" parameter and a -umlCommand "hide empty members" to hide class circles and empty members (be sure to include the quotes). For more information, please see (http://plantuml.com/classes.html).
Since version 1.0.1:
-umlAlwaysUseQualifiedClassnames boolean	false	Whether the new simplified classnames within packages (namespaces) must be disabled. Simplified names should have no effect on the rendered diagrams, but instead only result in more easily readable .puml sources. This setting was introduced to be able to turn off the changes from enhancement 15.
Since version 1.0.2:
-umlImageFormat image formats	SVG	The image formats to be generated in case the plantuml library is detected on the classpath. Options that are supported out of the box include: PNG, SVG, EPS and LATEX (see net.sourceforge.plantuml.FileFormat). To generate rendered diagrams in multiple formats, simply provide the -umlImageFormat parameter more than once. Please note, since version 1.0.3, the default changed from PNG to none to avoid excessively large javadoc JAR files. SVG also generates considerably smaller images which scale better and allow moderate copy-paste functionality.
Since version 1.0.4:
-umlImageDirectory image directory	none	The (single) directory where all images will be generated to. By default images are placed in the directory containing their package documentation. When a single directory is configured for the images, the filename for the image will include the full package names (for more details, see enhancement 25 ).
Since version 1.0.5:
-umlPackageDependencies boolean	true	Whether properties are replaced by dependencies if the type is known in the diagram.
Since version 1.0.9:
-umlIncludeHyperlinks boolean	!umlSkipStandardDoclet	Whether hyperlinks to regular JavaDoc should be included in the generated uml.