Skip to content

Commit

Permalink
Whitespace fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
szegedi committed Jun 21, 2011
1 parent d522956 commit ed3657c
Showing 1 changed file with 24 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@
import java.net.URI;

/**
* Represents the source text of the module as a tuple of a reader, a URI, a
* Represents the source text of the module as a tuple of a reader, a URI, a
* security domain, and a cache validator.
* <h1>Cache validators<h1>. Validators are used by caches subclasses from
* {@link CachingModuleScriptProviderBase} to avoid repeated loading of
* unmodified resources as well as automatic reloading of modified resources).
* <h1>Cache validators<h1>. Validators are used by caches subclasses from
* {@link CachingModuleScriptProviderBase} to avoid repeated loading of
* unmodified resources as well as automatic reloading of modified resources).
* Such a validator can be any value that can be used to detect modification or
* non-modification of the resource that provided the source of the module. It
* can be as simple as a tuple of a URI or a file path, and a last-modified
* date, or an ETag (in case of HTTP). It is left to the implementation. It is
* also allowed to carry expiration information (i.e. in case of HTTP
* non-modification of the resource that provided the source of the module. It
* can be as simple as a tuple of a URI or a file path, and a last-modified
* date, or an ETag (in case of HTTP). It is left to the implementation. It is
* also allowed to carry expiration information (i.e. in case of HTTP
* expiration header, or if a default expiration is used by the source provider
* to avoid too frequent lookup of the resource), and to short-circuit the
* to avoid too frequent lookup of the resource), and to short-circuit the
* validation in case the validator indicates the cached representation has not
* yet expired. All these are plainly recommendations; the validators are
* considered opaque and should only make sure to implement
* yet expired. All these are plainly recommendations; the validators are
* considered opaque and should only make sure to implement
* {@link Object#equals(Object)} as caches themselves can rely on it to compare
* them semantically. Also, it is advisable to have them be serializable.
* @author Attila Szegedi
Expand All @@ -30,16 +30,16 @@ public class ModuleSource implements Serializable
private static final long serialVersionUID = 1L;

private final Reader reader;
private final Object securityDomain;
private final Object securityDomain;
private final URI uri;
private final URI base;
private final Object validator;

/**
* Creates a new module source.
* @param reader the reader returning the source text of the module.
* @param securityDomain the object representing the security domain for
* the module's source (passed to Rhino script compiler).
* @param securityDomain the object representing the security domain for
* the module's source (passed to Rhino script compiler).
* @param uri the URI of the module's source text
* @param validator a validator that can be used for subsequent cache
* validation of the source text.
Expand All @@ -52,27 +52,27 @@ public ModuleSource(Reader reader, Object securityDomain, URI uri,
this.base = base;
this.validator = validator;
}

/**
* Returns the reader returning the source text of the module. Note that
* subsequent calls to this method return the same object, thus it is not
* possible to read the source twice.
* @return the reader returning the source text of the module.
* @return the reader returning the source text of the module.
*/
public Reader getReader() {
return reader;
}

/**
* Returns the object representing the security domain for the module's
* Returns the object representing the security domain for the module's
* source.
* @return the object representing the security domain for the module's
* @return the object representing the security domain for the module's
* source.
*/
public Object getSecurityDomain() {
return securityDomain;
}

/**
* Returns the URI of the module source text.
* @return the URI of the module source text.
Expand All @@ -91,9 +91,9 @@ public URI getBase() {
}

/**
* Returns the validator that can be used for subsequent cache validation
* of the source text.
* @return the validator that can be used for subsequent cache validation
* Returns the validator that can be used for subsequent cache validation
* of the source text.
* @return the validator that can be used for subsequent cache validation
* of the source text.
*/
public Object getValidator() {
Expand Down

0 comments on commit ed3657c

Please sign in to comment.