gov.nist.secauto.metaschema.model.common.INamedModelDefinition Maven / Gradle / Ivy
Show all versions of metaschema-model-common Show documentation
/*
* 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.
*/
package gov.nist.secauto.metaschema.model.common;
import gov.nist.secauto.metaschema.model.common.constraint.IAllowedValuesConstraint;
import gov.nist.secauto.metaschema.model.common.constraint.IExpectConstraint;
import gov.nist.secauto.metaschema.model.common.constraint.IIndexHasKeyConstraint;
import gov.nist.secauto.metaschema.model.common.constraint.IMatchesConstraint;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collection;
import java.util.List;
/**
* This marker interface identifies a definition that is intended to be part of an Assembly's model.
*
* These definitions contain flags, and potentially a simple value (for a field) or complex model
* contents (for an assembly).
*/
public interface INamedModelDefinition extends INamedDefinition {
/**
* Identifies if the field has flags or not.
*
* @return {@code true} if the field has not flags, or false otherwise
*/
default boolean isSimple() {
return getFlagInstances().isEmpty();
}
/**
* Retrieves a flag instance, by the flag's effective name, that is defined on the containing
* definition.
*
* @param name
* the flag's name
* @return the matching flag instance, or {@code null} if there is no flag matching the specified
* name
*/
@Nullable
IFlagInstance getFlagInstanceByName(String name);
/**
* Retrieves the flag instances for all flags defined on the containing definition.
*
* @return the flags
*/
@NotNull
Collection<@NotNull ? extends IFlagInstance> getFlagInstances();
/**
* Indicates if a flag's value can be used as a property name in the containing object in JSON who's
* value will be the object containing the flag. In such cases, the flag will not appear in the
* object. This is only allowed if the flag is required, as determined by a {@code true} result from
* {@link IFlagInstance#isRequired()}. The {@link IFlagInstance} can be retrieved using
* {@link #getJsonKeyFlagInstance()}.
*
* @return {@code true} if the flag's value can be used as a property name, or {@code false}
* otherwise
* @see #getJsonKeyFlagInstance()
*/
// TODO: remove
boolean hasJsonKey();
/**
* Retrieves the flag instance to use as as the property name for the containing object in JSON
* who's value will be the object containing the flag.
*
* @return the flag instance if a JSON key is configured, or {@code null} otherwise
* @see #hasJsonKey()
*/
// TODO: remove
@Nullable
IFlagInstance getJsonKeyFlagInstance();
/**
* Retrieve the list of allowed value constraints that apply to this definition's descendant flag or
* field values.
*
* @return the list of allowed value constraints
*/
@NotNull
List<@NotNull ? extends IAllowedValuesConstraint> getAllowedValuesContraints();
/**
* Retrieve the list of matches constraints that apply to this definition's descendant flag or field
* values.
*
* @return the list of matches constraints
*/
@NotNull
List<@NotNull ? extends IMatchesConstraint> getMatchesConstraints();
/**
* Retrieve the list of key reference constraints that apply to this definition's descendant flag or
* field values.
*
* @return the list of key reference constraints
*/
@NotNull
List<@NotNull ? extends IIndexHasKeyConstraint> getIndexHasKeyConstraints();
/**
* Retrieve the list of expect constraints that apply to this definition's descendant flag or field
* values.
*
* @return the list of expect constraints
*/
@NotNull
List<@NotNull ? extends IExpectConstraint> getExpectConstraints();
}