Package gov.nist.secauto.oscal.lib.profile.resolver.policy

Interface IReferencePolicy<T>

All Known Subinterfaces:

ICustomReferencePolicy<TYPE>

All Known Implementing Classes:

AbstractCustomReferencePolicy, AbstractMultiItemTypeReferencePolicy, AnchorReferencePolicy, InsertReferencePolicy, LinkReferencePolicy, PropertyReferencePolicy

public interface IReferencePolicy<T>

Field Summary

Fields

Modifier and Type	Field	Description
static IReferencePolicy<Object>	IGNORE_POLICY

Method Summary

Modifier and Type	Method	Description
boolean	handleReference(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem, T reference, ReferenceCountingVisitor.Context referenceVisitorContext)	Handle the provided reference.
static <T> IReferencePolicy<T>	ignore()	Get a reference policy that will ignore processing the reference.

Field Detail

IGNORE_POLICY

@NonNull
static final IReferencePolicy<Object> IGNORE_POLICY

Method Detail

ignore

@NonNull
static <T> IReferencePolicy<T> ignore()

Get a reference policy that will ignore processing the reference.

Type Parameters:

T - the type of the reference object

Returns:

the policy

handleReference

boolean handleReference(@NonNull
                        gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem,
                        @NonNull
                        T reference,
                        @NonNull
                        ReferenceCountingVisitor.Context referenceVisitorContext)

Handle the provided reference.

Parameters:

contextItem - the nodes containing the reference

reference - the reference object to process

referenceVisitorContext - used to lookup and resolve items

Returns:

true if the reference was handled, or false otherwise

Throws:

ProfileResolutionEvaluationException - if there was an error handing the reference