org.btrplace.json.model.constraint.ConstraintConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scheduler-json Show documentation
Show all versions of scheduler-json Show documentation
Read and write model according to the JSON format
/*
* Copyright (c) 2017 University Nice Sophia Antipolis
*
* This file is part of btrplace.
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see .
*/
package org.btrplace.json.model.constraint;
import net.minidev.json.JSONObject;
import org.btrplace.json.JSONConverterException;
import org.btrplace.model.Model;
import org.btrplace.model.constraint.Constraint;
/**
* Specify a JSON converter for a {@link org.btrplace.model.constraint.Constraint}.
*
* @author Fabien Hermenier
*/
public interface ConstraintConverter {
/**
* The key identifier for the view type.
*/
String IDENTIFIER = "id";
/**
* Get the name of the constraint that is supported by the converter.
*
* @return The constraint class
*/
Class getSupportedConstraint();
/**
* Get the JSON identifier for the constraint.
*
* @return a non-empty string
*/
String getJSONId();
/**
* Check if the JSON object can be converted using this converter.
* For being convertible, the key 'id' must be equals to {@link #getJSONId()}.
*
* @param o the object to test
* @throws JSONConverterException if the object is not compatible
*/
default void checkId(JSONObject o) throws JSONConverterException {
Object id = o.get(ConstraintConverter.IDENTIFIER);
if (id == null || !id.toString().equals(getJSONId())) {
throw new JSONConverterException("Incorrect converter for " + o.toJSONString() + ". Expecting a constraint id '" + id + "'");
}
}
/**
* Convert a json-encoded constraint.
*
* @param mo the model to rely on
* @param o the constraint to decode
* @return the resulting constraint
* @throws JSONConverterException if the conversion failed
*/
E fromJSON(Model mo, JSONObject o) throws JSONConverterException;
/**
* Serialise a constraint.
* @param o the constraint
* @return the resulting encoded constraint
*/
JSONObject toJSON(E o);
/**
* Serialise a constraint.
* @param d the constraint to serialise
* @return the JSON-encoded constraint
*/
default String toJSONString(E d) {
return toJSON(d).toJSONString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy