Package org.verapdf.component

Class Components

java.lang.Object

org.verapdf.component.Components

public final class Components
extends Object

Factory class for veraPDF components and associated classes.

Version:

0.1 Created 27 Oct 2016:00:13:55

Author:

Carl Wilson carlwilson AT github

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Components.Timer	Convenience factory class to facilitate the creation of AuditDurations.

Method Summary

Modifier and Type	Method	Description
static ComponentDetails	defaultDetails()
static AuditDuration	defaultDuration()
static ComponentDetails	detailsFromValues(URI id, String name, String version, String provider, String description)	Create a new new ComponentDetails instance from the passed values
static ComponentDetails	libraryDetails(URI id, String name)	Convenience method that creates a ComponentDetails instance with the veraPDF library version number and description.
static ComponentDetails	veraDetails(URI id, String name, String version, String description)	Convenience method that creates a ComponentDetails instance with the veraPDF library description.

Methods inherited from class java.lang.Object

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

Method Detail

defaultDetails

public static ComponentDetails defaultDetails()

Returns:

the default ComponentDetails instance.

libraryDetails

public static ComponentDetails libraryDetails(URI id,
                                              String name)

Convenience method that creates a ComponentDetails instance with the veraPDF library version number and description.

Parameters:

id - a preferably unique URI that identifies the ComponentDetails.

name - the name to be assigned the ComponentDetails

Returns:

a new ComponentDetails instance populated using the passed parameters

veraDetails

public static ComponentDetails veraDetails(URI id,
                                           String name,
                                           String version,
                                           String description)

Convenience method that creates a ComponentDetails instance with the veraPDF library description.

Parameters:

id - a preferably unique URI that identifies the ComponentDetails.

name - the name to be assigned the ComponentDetails

description - the description to be assigned to the ComponentDetails instance.

Returns:

a new ComponentDetails instance populated using the passed parameters

detailsFromValues

public static ComponentDetails detailsFromValues(URI id,
                                                 String name,
                                                 String version,
                                                 String provider,
                                                 String description)

Create a new new ComponentDetails instance from the passed values

Parameters:

id - a unique URI identifying the Component

name - a String name for the Component

version - the version of the Component

provider - the provider of the Component

description - a description for the Component

Returns:

a new Component instance populated from the passed values.

defaultDuration

public static AuditDuration defaultDuration()

Returns:

the default AuditDuration instance