comparison 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
comparison
equal deleted inserted replaced
490:b3c16d1aede0 491:4a670f76e7d1
162 @Override 162 @Override
163 public String toString() { 163 public String toString() {
164 return getClass().getSimpleName() + "[" + getLocation() + (isInvalid() ? "(BAD)" : "") + "]"; 164 return getClass().getSimpleName() + "[" + getLocation() + (isInvalid() ? "(BAD)" : "") + "]";
165 } 165 }
166 166
167 /**
168 * Path to repository which has been used to initialize this instance. The value is always present, even
169 * if no repository has been found at that location ({@link #isInvalid()} is <code>true</code>) and serves
170 * as an extra description of the failure.
171 *
172 * <p> It's important to understand this is purely descriptive attribute, it's kept as close as possible to
173 * original value users supply to {@link HgLookup}. To get actual repository location, use methods that
174 * provide {@link File}, e.g. {@link #getWorkingDir()}
175 *
176 * @return repository location information, never <code>null</code>
177 */
167 public String getLocation() { 178 public String getLocation() {
168 return repoLocation; 179 return repoLocation;
169 } 180 }
170 181
171 public boolean isInvalid() { 182 public boolean isInvalid() {