Commit b2463aab authored by cdanger's avatar cdanger

- DecisionCache: improved javadoc

parent f5a1c848
......@@ -48,7 +48,8 @@ public interface DecisionCache extends Closeable
*
* @param conf
* extension parameters
* @param envProps environment properties
* @param envProps
* environment properties
* @return instance of extension
*/
public abstract DecisionCache getInstance(CONF_T conf, EnvironmentProperties envProps);
......@@ -71,7 +72,8 @@ public interface DecisionCache extends Closeable
* @param evalCtx
* evaluation context that can be used to save context about any partial/preliminary evaluation done by this decision cache when there is no cached result for {code request} yet. In
* this case, the PDP will call back {@link DecisionCache#put(DecisionRequest, DecisionResult, EvaluationContext)} with this same {@code evalCtx} after the PDP has computed the new
* result. Therefore, this allows the decision cache to reuse some context during an evaluation, and also to do some evaluation itself.
* result. Therefore, this allows the decision cache to reuse some context during an evaluation, and also to do some evaluation itself. This argument may be null if not required, i.e.
* {@link #isEvaluationContextRequired()} returns false.
* @return the corresponding decision result from cache; null if there is no such result in cache.
*/
DecisionResult get(DecisionRequest request, EvaluationContext evalCtx);
......@@ -97,7 +99,7 @@ public interface DecisionCache extends Closeable
* the corresponding decision result
* @param evalCtx
* evaluation context that can be used to retrieve context about any partial/preliminary evaluation done by this decision cache when {@link #get(DecisionRequest, EvaluationContext)} was
* called in the same request context.
* called in the same request context. This argument may be null if not required, i.e. {@link #isEvaluationContextRequired()} returns false.
*/
void put(DecisionRequest request, DecisionResult result, EvaluationContext evalCtx);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment