Skip to content
Browse files

make clear in docs that ConfigIncludeContext should not be implemente…

…d by apps
  • Loading branch information...
1 parent 5e7b929 commit ce352691ff4f4c2181be6f54bdb7204ab184b3ce @havocp havocp committed Apr 8, 2012
Showing with 7 additions and 0 deletions.
  1. +7 −0 config/src/main/java/com/typesafe/config/ConfigIncludeContext.java
View
7 config/src/main/java/com/typesafe/config/ConfigIncludeContext.java
@@ -8,6 +8,13 @@
* Context provided to a {@link ConfigIncluder}; this interface is only useful
* inside a {@code ConfigIncluder} implementation, and is not intended for apps
* to implement.
+ *
+ * <p>
+ * <em>Do not implement this interface</em>; 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 {
/**

0 comments on commit ce35269

Please sign in to comment.
Something went wrong with that request. Please try again.