001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.core.model.constraint; 028 029import java.util.Map; 030 031import edu.umd.cs.findbugs.annotations.NonNull; 032import edu.umd.cs.findbugs.annotations.Nullable; 033 034/** 035 * Represents a rule requiring the value of a field or flag to match the name of 036 * one entry in a set of enumerated values. 037 */ 038public interface IAllowedValuesConstraint extends IConstraint { 039 boolean DEFAULT_ALLOW_OTHER = false; 040 @NonNull 041 Extensible DEFAULT_EXTENSIBLE = Extensible.MODEL; 042 043 enum Extensible { 044 /** 045 * Can be extended by external constraints. The most permissive level. 046 */ 047 EXTERNAL, 048 /** 049 * Can be extended by constraints in the same model. 050 */ 051 MODEL, 052 /** 053 * Cannot be extended. The most restrictive level. 054 */ 055 NONE; 056 } 057 058 /** 059 * Get the collection allowed values associated with this constraint. 060 * 061 * @return a mapping of value to the associated {@link IAllowedValue} item 062 */ 063 @NonNull 064 Map<String, ? extends IAllowedValue> getAllowedValues(); 065 066 /** 067 * Get a specific allowed value by name, if it is defined for this constraint. 068 * 069 * @param name 070 * the value name 071 * @return the allowed value or {@code null} if the value is not defined 072 */ 073 @Nullable 074 default IAllowedValue getAllowedValue(String name) { 075 return getAllowedValues().get(name); 076 } 077 078 /** 079 * Determines if this allowed value constraint is open-ended ({@code true}) or 080 * closed. If "open-ended", the constraint allows the target's value to by any 081 * additional unspecified value. If "closed", the constraint requries the 082 * target's value to be one of the specified values. 083 * 084 * @return {@code true} if the constraint is "open-ended", or {@code false} 085 * otherwise 086 */ 087 boolean isAllowedOther(); 088 089 /** 090 * Determines the degree to which this constraint can be extended by other 091 * constraints applied to the same value. 092 * 093 * @return the enumeration value 094 */ 095 @NonNull 096 Extensible getExtensible(); 097}