io.permazen.core.InvalidReferenceException Maven / Gradle / Ivy

Go to download

/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package io.permazen.core;

import java.util.Set;

/**
 * Thrown when attempting to set a reference field to a disallowed object type.
 *
 * @see ReferenceField#getObjectTypes
 */
@SuppressWarnings("serial")
public class InvalidReferenceException extends IllegalArgumentException {

    private final ObjId id;
    private final Set objectTypes;

    /**
     * Constructor.
     *
     * @param id offending object's ID
     * @param objectTypes allowed object types
     */
    public InvalidReferenceException(ObjId id, Set objectTypes) {
        super("illegal reference " + id + " with object type #" + id.getStorageId() + "; allowed object types are " + objectTypes);
        this.id = id;
        this.objectTypes = objectTypes;
    }

    /**
     * Constructor.
     *
     * @param field disallowing field
     * @param id offending object's ID
     */
    public InvalidReferenceException(ReferenceField field, ObjId id) {
        this(id, field.getObjectTypes());
    }

    /**
     * Get the {@link ObjId} of the object that could not be assigned to the reference field due to disallowed object type.
     *
     * @return the object having disallowed type
     */
    public ObjId getObjId() {
        return this.id;
    }

    /**
     * Get the set of object types that are allowed to be referenced by the reference field.
     *
     * @return set of allowed object type storage IDs
     */
    public Set getObjectTypes() {
        return this.objectTypes;
    }
}