From ce352691ff4f4c2181be6f54bdb7204ab184b3ce Mon Sep 17 00:00:00 2001 From: Havoc Pennington Date: Sun, 8 Apr 2012 10:04:22 -0400 Subject: [PATCH] make clear in docs that ConfigIncludeContext should not be implemented by apps --- .../java/com/typesafe/config/ConfigIncludeContext.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/config/src/main/java/com/typesafe/config/ConfigIncludeContext.java b/config/src/main/java/com/typesafe/config/ConfigIncludeContext.java index ac3644a5..6a866726 100644 --- a/config/src/main/java/com/typesafe/config/ConfigIncludeContext.java +++ b/config/src/main/java/com/typesafe/config/ConfigIncludeContext.java @@ -8,6 +8,13 @@ package com.typesafe.config; * Context provided to a {@link ConfigIncluder}; this interface is only useful * inside a {@code ConfigIncluder} implementation, and is not intended for apps * to implement. + * + *

+ * Do not implement this interface; it should only be implemented by + * the config library. Arbitrary implementations will not work because the + * library internals assume a specific concrete implementation. Also, this + * interface is likely to grow new methods over time, so third-party + * implementations will break. */ public interface ConfigIncludeContext { /**