Author: rombert
Date: Mon Jun 30 13:43:06 2014
New Revision: 1606732
URL: http://svn.apache.org/r1606732
Log:
Added javadoc for ResourceProxy
Modified:
sling/trunk/tooling/ide/api/src/org/apache/sling/ide/transport/ResourceProxy.java
Modified:
sling/trunk/tooling/ide/api/src/org/apache/sling/ide/transport/ResourceProxy.java
URL:
http://svn.apache.org/viewvc/sling/trunk/tooling/ide/api/src/org/apache/sling/ide/transport/ResourceProxy.java?rev=1606732&r1=1606731&r2=1606732&view=diff
==============================================================================
---
sling/trunk/tooling/ide/api/src/org/apache/sling/ide/transport/ResourceProxy.java
(original)
+++
sling/trunk/tooling/ide/api/src/org/apache/sling/ide/transport/ResourceProxy.java
Mon Jun 30 13:43:06 2014
@@ -21,6 +21,24 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * The <tt>ResourceProxy</tt> is a representation of a resource as found in
the local workspace
+ *
+ * <p>
+ * The resource usually has properties, as returned from <tt>{@link
#getProperties()}</tt>. If no properties are found,
+ * it means that the resource is only a reference and not that it is an empty
resource.
+ * </p>
+ *
+ * <p>
+ * The resource only has information about the first row of children, as
returned by {@link #getChildren()}. It does not
+ * necessarily know about second-level children.
+ * </p>
+ *
+ * <p>
+ * By exception, if the child is <tt>covered</tt>, then all information about
that child and its descendants is known.
+ * </p>
+ *
+ */
public class ResourceProxy {
private final String path;
