From 0d27ede39392e8a8f959cfb2f0e111bada08c0a8 Mon Sep 17 00:00:00 2001 From: yegor256 Date: Tue, 6 Jun 2017 11:41:47 +0300 Subject: [PATCH] #86: doc --- src/main/java/org/cactoos/io/ResourceAsInput.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/cactoos/io/ResourceAsInput.java b/src/main/java/org/cactoos/io/ResourceAsInput.java index ed8dbf9bb8..0773d0166c 100644 --- a/src/main/java/org/cactoos/io/ResourceAsInput.java +++ b/src/main/java/org/cactoos/io/ResourceAsInput.java @@ -29,7 +29,12 @@ import org.cactoos.text.FormattedText; /** - * Jar class resource. + * Classpath resource. + * + *

Pay attention that the name of resource must always be + * global, not starting with a leading slash. Thus, + * if you want to load a text file from {@code /com/example/Test.txt}, + * you must provide this name: {@code "com/example/Test.txt"}.

* * @author Kirill (g4s8.public@gmail.com) * @version $Id$