Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Jan 17, 2024
1 parent a4c5270 commit c14433f
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ protected Certificate[] doGetCertificates() throws Exception {
}

/**
* Return file content info.
* Gets file content info.
*
* @return the file content info of the delegee.
* @throws Exception Any thrown Exception is wrapped in FileSystemException.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ protected FileContentInfoFactory getFileContentInfoFactory() {
}

/**
* Return the internal {@code URI} object mapped to this file object.
* Gets the internal {@code URI} object mapped to this file object.
*
* @return the internal {@code URI} object mapped to this file object
*/
Expand All @@ -207,7 +207,7 @@ protected URI getInternalURI() {
}

/**
* Return the last executed HEAD {@code HttpResponse} object.
* Gets the last executed HEAD {@code HttpResponse} object.
*
* @return the last executed HEAD {@code HttpResponse} object
* @throws IOException if IO error occurs
Expand All @@ -221,7 +221,7 @@ HttpResponse getLastHeadResponse() throws IOException {
}

/**
* Return URL charset string.
* Gets URL charset string.
* @return URL charset string
*/
protected String getUrlCharset() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ protected void doCloseCommunicationLink() {
}

/**
* Return the internal {@link HttpClient} instance.
* Gets the internal {@link HttpClient} instance.
*
* @return the internal {@link HttpClient} instance
*/
Expand All @@ -106,7 +106,7 @@ protected HttpClient getHttpClient() {
}

/**
* Return the internal {@link HttpClientContext} instance.
* Gets the internal {@link HttpClientContext} instance.
*
* @return the internal {@link HttpClientContext} instance
*/
Expand All @@ -115,7 +115,7 @@ protected HttpClientContext getHttpClientContext() {
}

/**
* Return the internal base {@code URI} instance.
* Gets the internal base {@code URI} instance.
*
* @return the internal base {@code URI} instance
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -251,15 +251,15 @@ public boolean getFollowRedirect(final FileSystemOptions opts) {
}

/**
* Return keystore file path to be used in SSL connections.
* Gets keystore file path to be used in SSL connections.
* @param opts the file system options to modify
* @return keystore file path to be used in SSL connections
*/
public String getKeyStoreFile(final FileSystemOptions opts) {
return getParam(opts, KEYSTORE_FILE);
}
/**
* Return keystore pass phrase for SSL connections.
* Gets keystore pass phrase for SSL connections.
* @param opts the file system options to modify
* @return keystore pass phrase for SSL connections
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ protected FileContentInfoFactory getFileContentInfoFactory() {
}

/**
* Return the internal {@code URI} object mapped to this file object.
* Gets the internal {@code URI} object mapped to this file object.
*
* @return the internal {@code URI} object mapped to this file object
*/
Expand All @@ -203,7 +203,7 @@ protected URI getInternalURI() {
}

/**
* Return the last executed HEAD {@code HttpResponse} object.
* Gets the last executed HEAD {@code HttpResponse} object.
*
* @return the last executed HEAD {@code HttpResponse} object
* @throws IOException if IO error occurs
Expand All @@ -217,7 +217,7 @@ HttpResponse getLastHeadResponse() throws IOException {
}

/**
* Return URL charset string.
* Gets URL charset string.
* @return URL charset string
*/
protected String getUrlCharset() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ protected void doCloseCommunicationLink() {
}

/**
* Return the internal {@link HttpClient} instance.
* Gets the internal {@link HttpClient} instance.
*
* @return the internal {@link HttpClient} instance
*/
Expand All @@ -104,7 +104,7 @@ protected HttpClient getHttpClient() {
}

/**
* Return the internal {@link HttpClientContext} instance.
* Gets the internal {@link HttpClientContext} instance.
*
* @return the internal {@link HttpClientContext} instance
*/
Expand All @@ -113,7 +113,7 @@ protected HttpClientContext getHttpClientContext() {
}

/**
* Return the internal base {@code URI} instance.
* Gets the internal base {@code URI} instance.
*
* @return the internal base {@code URI} instance
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ public boolean getFollowRedirect(final FileSystemOptions opts) {
}

/**
* Return keystore file path to be used in SSL connections.
* Gets keystore file path to be used in SSL connections.
* @param opts the file system options to modify
* @return keystore file path to be used in SSL connections
*/
Expand All @@ -277,7 +277,7 @@ public String getKeyStoreFile(final FileSystemOptions opts) {
}

/**
* Return keystore pass phrase for SSL connections.
* Gets keystore pass phrase for SSL connections.
* @param opts the file system options to modify
* @return keystore pass phrase for SSL connections
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ protected Map<String, Object> doGetAttributes() throws Exception {
}

/**
* Return the certificates of this JarEntry.
* Gets the certificates of this JarEntry.
*/
@Override
protected Certificate[] doGetCertificates() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public Collection<Capability> getCapabilities() {
}

/**
* Return config builder.
* Gets config builder.
*
* @return A config builder for ZipFileProvider.
* @see org.apache.commons.vfs2.provider.AbstractFileProvider#getConfigBuilder()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public final class CryptorFactory {
private static Cryptor instance;

/**
* Return the Cryptor. If one has not been previously set, create it. The Cryptor class can be set by setting the
* Gets the Cryptor. If one has not been previously set, create it. The Cryptor class can be set by setting the
* "org.apache.commons.vfs2.cryptor" System property to the name of the Cryptor class.
*
* @return The Cryptor.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public enum Type {
}

/**
* Return the mask for this permission.
* Gets the mask for this permission.
*
* @return the mask for this permission.
*/
Expand Down

0 comments on commit c14433f

Please sign in to comment.