diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelField.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelField.java index d27f106da..d3307841f 100644 --- a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelField.java +++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/IBoundInstanceModelField.java @@ -87,5 +87,4 @@ default boolean canHandleXmlQName(QName qname) { } return retval; } - } diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/impl/package-info.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/impl/package-info.java index 1316bbc9e..9c4d1cf32 100644 --- a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/impl/package-info.java +++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/impl/package-info.java @@ -26,8 +26,8 @@ /** * Provides an implementation of the Module model - * ({@link gov.nist.secauto.metaschema.core.model}) representing module - * constructs as bound Java class annotations + * ({@link gov.nist.secauto.metaschema.core.model}) represented by bound Java + * class annotations * ({@link gov.nist.secauto.metaschema.databind.model.annotations}). */ diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/metaschema/binding/package-info.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/metaschema/binding/package-info.java index f0b9eef72..93c990d9a 100644 --- a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/metaschema/binding/package-info.java +++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/metaschema/binding/package-info.java @@ -24,6 +24,11 @@ * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. */ + +/** + * A Metaschema module represented as a set of Metaschema module bindings. + */ + @gov.nist.secauto.metaschema.databind.model.annotations.MetaschemaPackage(moduleClass = { MetaschemaModelModule.class }) @gov.nist.secauto.metaschema.databind.model.annotations.XmlSchema( namespace = "http://csrc.nist.gov/ns/oscal/metaschema/1.0", diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/metaschema/package-info.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/metaschema/package-info.java new file mode 100644 index 000000000..a45303819 --- /dev/null +++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/metaschema/package-info.java @@ -0,0 +1,34 @@ +/* + * Portions of this software was developed by employees of the National Institute + * of Standards and Technology (NIST), an agency of the Federal Government and is + * being made available as a public service. Pursuant to title 17 United States + * Code Section 105, works of NIST employees are not subject to copyright + * protection in the United States. This software may be subject to foreign + * copyright. Permission in the United States and in foreign countries, to the + * extent that NIST may hold copyright, to use, copy, modify, create derivative + * works, and distribute this software and its documentation without fee is hereby + * granted on a non-exclusive basis, provided that this notice and disclaimer + * of warranty appears in all copies. + * + * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER + * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY + * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM + * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE + * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT + * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, + * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, + * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, + * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR + * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT + * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. + */ + +/** + * Provides an implementation of the Module model + * ({@link gov.nist.secauto.metaschema.core.model}) represented by a + * module-specific set of bound Java classes + * ({@link gov.nist.secauto.metaschema.databind.metaschema.binding}). + */ + +package gov.nist.secauto.metaschema.databind.model.metaschema; diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/package-info.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/package-info.java index 4cabc3660..b92bac6ff 100644 --- a/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/package-info.java +++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/model/package-info.java @@ -26,9 +26,9 @@ /** * Provides an overlay of the Metaschema module model - * ({@link gov.nist.secauto.metaschema.core.model}) representing module - * constructs as bound Java class annotations - * ({@link gov.nist.secauto.metaschema.databind.model.annotations}). + * ({@link gov.nist.secauto.metaschema.core.model}) using bound Java class + * annotations ({@link gov.nist.secauto.metaschema.databind.model.annotations}) + * to represent module constructs annotated on Java classes. */ package gov.nist.secauto.metaschema.databind.model; diff --git a/databind/src/main/java/gov/nist/secauto/metaschema/databind/package-info.java b/databind/src/main/java/gov/nist/secauto/metaschema/databind/package-info.java index 64de47654..46c240373 100644 --- a/databind/src/main/java/gov/nist/secauto/metaschema/databind/package-info.java +++ b/databind/src/main/java/gov/nist/secauto/metaschema/databind/package-info.java @@ -24,7 +24,23 @@ * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. */ /** - * The core implementation of the metaschema binding framework. + * Support for parsing Metaschema module-based data using Java class bindings. + *
+ * Two methods are supported + *