Mercurial > hg4j
diff src/org/tmatesoft/hg/repo/HgRepository.java @ 491:4a670f76e7d1
Javadoc for HgRepository#getLocation()
author | Artem Tikhomirov <tikhomirov.artem@gmail.com> |
---|---|
date | Tue, 16 Oct 2012 21:07:27 +0200 |
parents | b3c16d1aede0 |
children | ba36f66c32b4 |
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/repo/HgRepository.java Thu Aug 16 17:08:34 2012 +0200 +++ b/src/org/tmatesoft/hg/repo/HgRepository.java Tue Oct 16 21:07:27 2012 +0200 @@ -164,6 +164,17 @@ return getClass().getSimpleName() + "[" + getLocation() + (isInvalid() ? "(BAD)" : "") + "]"; } + /** + * Path to repository which has been used to initialize this instance. The value is always present, even + * if no repository has been found at that location ({@link #isInvalid()} is <code>true</code>) and serves + * as an extra description of the failure. + * + * <p> It's important to understand this is purely descriptive attribute, it's kept as close as possible to + * original value users supply to {@link HgLookup}. To get actual repository location, use methods that + * provide {@link File}, e.g. {@link #getWorkingDir()} + * + * @return repository location information, never <code>null</code> + */ public String getLocation() { return repoLocation; }