JCLOUDS-546: Remove Javadoc @author annotations

Annotations removed with:

find -name \*.java | xargs sed -i /@author/d

Empty Javadoc removed with multiple iterations of:

find -name \*.java | xargs sed -i -z 's/ \*\n \*\// \*\//'
find -name \*.java | xargs sed -i -z 's/ \* \n \*\// \*\//'
find -name \*.java | xargs sed -i -z 's/\/\*\*\n \*\/\n//'
This commit is contained in:
Andrew Gaul
2014-06-06 19:16:34 -07:00
parent 39f77ad3f8
commit 9cdd53b0b7
4416 changed files with 1 additions and 11639 deletions
@@ -30,8 +30,6 @@ import com.google.common.collect.Maps;
/**
* Creates an environment file
*
* @author Adrian Cole
*/
public class EnvBuilder {
@@ -25,9 +25,6 @@ import com.google.common.collect.ForwardingObject;
/**
* you cannot return from a top-level script, so if you are using snippets that
* issue {@code return} then you'll want to wrap them in this.
*
* @author Adrian Cole
*
*/
public class ExitInsteadOfReturn extends ForwardingObject implements Statement {
private final Statement delegate;
@@ -47,8 +47,6 @@ import com.google.common.collect.ImmutableMap;
/**
* Creates an init script file
*
* @author Adrian Cole
*/
public class InitScript extends ForwardingObject implements Statement, AcceptsStatementVisitor {
@@ -43,8 +43,6 @@ import com.google.common.collect.Sets;
/**
* Creates a shell script.
*
* @author Adrian Cole
*/
public class ScriptBuilder implements Statement, AcceptsStatementVisitor {
@@ -16,10 +16,6 @@
*/
package org.jclouds.scriptbuilder.domain;
/**
*
* @author Adrian Cole
*/
public interface AcceptsStatementVisitor {
void accept(StatementVisitor visitor);
@@ -18,10 +18,6 @@ package org.jclouds.scriptbuilder.domain;
import org.jclouds.scriptbuilder.statements.login.AdminAccess;
/**
*
* @author Adrian Cole
*/
public abstract class AdminAccessVisitor implements StatementVisitor {
public abstract void visit(AdminAccess input);
@@ -30,8 +30,6 @@ import com.google.common.collect.Maps;
/**
* Creates a run script
*
* @author Adrian Cole
*/
public class AppendFile implements Statement {
public static final String DELIMITER = "END_OF_JCLOUDS_FILE";
@@ -28,8 +28,6 @@ import com.google.common.collect.ImmutableMap;
/**
* Statement used in a shell script
*
* @author Adrian Cole
*/
public class Call implements Statement {
@@ -19,8 +19,6 @@ package org.jclouds.scriptbuilder.domain;
/**
* Creates a run script
*
* @author Adrian Cole
*/
public class CreateOrOverwriteFile extends AppendFile {
public static Builder builder() {
@@ -42,8 +42,6 @@ import com.google.common.collect.Iterables;
/**
* Creates a run script
*
* @author Adrian Cole
*/
public class CreateRunScript extends StatementList {
public static final String DELIMITER = "END_OF_JCLOUDS_SCRIPT";
@@ -25,8 +25,6 @@ import com.google.common.base.Optional;
/**
* Description of git coordinates to checkout.
*
* @author Adrian Cole
*/
public class GitRepoAndRef {
@@ -23,8 +23,6 @@ import java.net.URI;
/**
* Defines the environment of a process that can be started in the background on an operating
* system.
*
* @author Adrian Cole
*/
public class InitMetadata {
@@ -27,8 +27,6 @@ import com.google.common.collect.ImmutableList;
/**
* Statement used in a shell script
*
* @author Adrian Cole
*/
public class InterpretableStatement implements Statement {
@@ -25,7 +25,6 @@ import java.net.URI;
* system.
*
* @see InitMetadata
* @author Adrian Cole
*/
public class JavaInitMetadata extends InitMetadata {
private final String javaHome;
@@ -25,8 +25,6 @@ import com.google.common.collect.ImmutableMap;
/**
* Statement used in a shell script
*
* @author Adrian Cole
*/
public class Kill implements Statement {
@@ -23,8 +23,6 @@ import com.google.common.collect.ImmutableList;
/**
* Statement used in a shell script without modifications apart from a trailing newline.
*
* @author Adrian Cole
*/
public class LiteralStatement implements Statement {
@@ -18,8 +18,6 @@ package org.jclouds.scriptbuilder.domain;
/**
* Type of an Operating System.
*
* @author Adrian Cole
*/
public enum OsFamily {
@@ -28,8 +28,6 @@ import com.google.common.collect.Multimap;
/**
* Pipes the content of the http response to a shell command that accepts input from stdin
*
* @author Adrian Cole
*/
public class PipeHttpResponseTo extends InterpretableStatement {
/**
@@ -22,8 +22,6 @@ import com.google.common.collect.Multimap;
/**
* Pipes the content of the http response to bash
*
* @author Adrian Cole
*/
public class PipeHttpResponseToBash extends PipeHttpResponseTo {
/**
@@ -22,8 +22,6 @@ import com.google.common.collect.Multimap;
/**
* Pipes the content of the http response to tar -xpzf
*
* @author Adrian Cole
*/
public class PipeHttpResponseToTarxpzfIntoDirectory extends PipeHttpResponseTo {
/**
@@ -26,8 +26,6 @@ import com.google.common.collect.Multimap;
/**
* saves the content of the http response to a file
*
* @author Adrian Cole
*/
public class SaveHttpResponseTo extends InterpretableStatement {
public static final String CURL = "curl -q -s -S -L --connect-timeout 10 --max-time 600 --retry 20";
@@ -28,8 +28,6 @@ import com.google.common.collect.Maps;
/**
* Constants used in shell scripting.
*
* @author Adrian Cole
*/
public enum ShellToken {
@@ -18,8 +18,6 @@ package org.jclouds.scriptbuilder.domain;
/**
* Statement used in a shell script
*
* @author Adrian Cole
*/
public interface Statement {
Iterable<String> functionDependencies(OsFamily family);
@@ -26,8 +26,6 @@ import com.google.common.collect.ImmutableList.Builder;
/**
* Statements used in a shell script
*
* @author Adrian Cole
*/
public class StatementList extends ForwardingList<Statement> implements Statement, AcceptsStatementVisitor {
@@ -16,10 +16,6 @@
*/
package org.jclouds.scriptbuilder.domain;
/**
*
* @author Adrian Cole
*/
public interface StatementVisitor {
void visit(Statement in);
}
@@ -26,8 +26,6 @@ import com.google.common.collect.Multimap;
/**
* Statements used in shell scripts.
*
* @author Adrian Cole
*/
public class Statements {
private static final Kill KILL = new Kill();
@@ -24,7 +24,6 @@ import java.net.URI;
* A java process that has a graceful shutdown mechanism.
*
* @see JavaInitMetadata
* @author Adrian Cole
*/
public class StoppableJavaInitMetadata extends JavaInitMetadata {
private final String[] stopClasspath;
@@ -33,8 +33,6 @@ import com.google.common.collect.Lists;
/**
* Statement used in a shell script
*
* @author Adrian Cole
*/
public class SwitchArg implements Statement, AcceptsStatementVisitor {
@@ -28,8 +28,6 @@ import com.google.common.collect.Multimap;
/**
* unzips the content into a directory
*
* @author Adrian Cole
*/
public class UnzipHttpResponseIntoDirectory extends InterpretableStatement {
/**
@@ -27,7 +27,6 @@ import com.google.common.collect.ImmutableMap;
/**
* A Data bag to be configured for a Chef Solo run.
*
* @author Ignasi Barrera
* @since Chef 0.10.4
*/
public class DataBag extends ForwardingMap<String, String> {
@@ -23,8 +23,6 @@ import com.google.common.base.Optional;
/**
* A Role to be configured for a Chef Solo run.
*
* @author Ignasi Barrera
*/
public class Role {
@@ -28,8 +28,6 @@ import com.google.common.collect.Lists;
/**
* A Run list to be executed in a Chef Solo run.
*
* @author Ignasi Barrera
*/
public class RunList {
@@ -29,8 +29,6 @@ import com.google.common.io.LineProcessor;
/**
* FunctionLoader decorator to filters out license header comments from a file.
*
* @author Ignasi Barrera
*/
public class LicenseHeaderFilter implements FunctionLoader {
@@ -65,7 +63,6 @@ public class LicenseHeaderFilter implements FunctionLoader {
/**
* Line by line processor.
*
* @author Ignasi Barrera
*/
private static class LicenseHeaderProcessor implements LineProcessor<String> {
@@ -28,10 +28,6 @@ import org.jclouds.scriptbuilder.statements.login.AdminAccess;
import com.google.common.base.Function;
import com.google.common.util.concurrent.Atomics;
/**
*
* @author Adrian Cole
*/
public enum CredentialsFromAdminAccess implements Function<Statement, Credentials> {
INSTANCE;
@Override
@@ -22,10 +22,6 @@ import org.jclouds.scriptbuilder.domain.AdminAccessVisitor;
import org.jclouds.scriptbuilder.statements.login.AdminAccess;
import org.jclouds.scriptbuilder.statements.login.AdminAccess.Configuration;
/**
*
* @author Adrian Cole
*/
public class InitAdminAccess extends AdminAccessVisitor {
private final AdminAccess.Configuration adminAccessConfiguration;
@@ -45,7 +45,6 @@ import com.google.common.collect.Lists;
/**
* Bootstraps a node using Chef Solo.
*
* @author Ignasi Barrera
*
* @see InstallChefGems
* @see InstallRuby
@@ -32,7 +32,6 @@ import com.google.common.collect.ImmutableSet;
* of Ruby and Rubygems, use the {@link InstallChefUsingOmnibus} statement
* instead.
*
* @author Ignasi Barrera
*
* @see InstallChefUsingOmnibus
* @see InstallRuby
@@ -35,7 +35,6 @@ import com.google.common.collect.ImmutableMultimap;
* If you want more control on the Ruby version or the gems being installed, use
* the {@link InstallChefGems} statement instead.
*
* @author Ignasi Barrera
*
* @see InstallChefGems
* @see InstallRuby
@@ -37,8 +37,6 @@ import com.google.common.collect.Iterables;
* using git branch -r), and creates and checks out an initial branch that is
* forked from the cloned gitRepoAndRef's currently active branch. PWD is set to
* the directory being checked out.
*
* @author Adrian Cole
*/
public class CloneGitRepo implements Statement {
@@ -22,8 +22,6 @@ import org.jclouds.scriptbuilder.domain.StatementList;
/**
* Installs git onto a host
*
* @author Adrian Cole
*/
public class InstallGit extends StatementList {
@@ -25,8 +25,6 @@ import org.jclouds.scriptbuilder.domain.StatementList;
/**
* Installs a default JDK to a host
*
* @author Adrian Cole
*/
public class InstallJDK {
@@ -68,8 +68,6 @@ import com.google.common.io.Files;
* sometimes known to the provider), securely and randomly as described above (resetLoginPassword)</li>
* <li>lockdown sshd_config for no root login, nor passwords allowed (lockSsh)</li>
* </ul>
*
* @author Adrian Cole
*/
public class AdminAccess implements Statement {
public static Builder builder() {
@@ -73,7 +73,6 @@ import com.google.common.collect.ImmutableMap;
* <p>
* Design inspired by {@link CacheBuilderSpec}
*
* @author David Alves
* @since 1.5
*/
@@ -31,8 +31,6 @@ import com.google.common.collect.ImmutableList;
/**
* Replaces the password entry for a user in the shadow file, using SHA-512
* crypt syntax.
*
* @author Adrian Cole
*/
public class ReplaceShadowPasswordEntry implements Statement {
@@ -19,10 +19,6 @@ package org.jclouds.scriptbuilder.statements.login;
import com.google.common.base.Function;
/**
*
* @author Adrian Cole
*/
public class ReplaceShadowPasswordEntryOfLoginUser extends ReplaceShadowPasswordEntry {
public ReplaceShadowPasswordEntryOfLoginUser(Function<String, String> cryptFunction, String password) {
@@ -20,8 +20,6 @@ import com.google.common.base.Function;
/**
* Statements used to manipulate the shadow file
*
* @author Adrian Cole
*/
public class ShadowStatements {
@@ -20,8 +20,6 @@ import org.jclouds.scriptbuilder.domain.Statement;
/**
* Statements used in sudo control
*
* @author Adrian Cole
*/
public class SudoStatements {
@@ -31,8 +31,6 @@ import com.google.common.collect.ImmutableSet;
/**
* Control /etc/sudoers
*
* @author Adrian Cole
*/
@Beta
public class Sudoers implements Statement {
@@ -46,8 +46,6 @@ import com.google.common.collect.Lists;
* <p>
* Note that some places where this is used may have stricter requirements on the parameters
* (for example {@link AdminAccess} requires password and keys).
*
* @author Adrian Cole
*/
public class UserAdd implements Statement {
public static UserAdd.Builder builder() {
@@ -23,8 +23,6 @@ import org.jclouds.scriptbuilder.domain.StatementList;
/**
* Installs Ruby onto a host.
*
* @author Ignasi Barrera
*/
public class InstallRuby extends StatementList {
@@ -33,8 +33,6 @@ import com.google.common.collect.ImmutableSet;
/**
* Installs RubyGems onto a host.
*
* @author Ignasi Barrera
*/
public class InstallRubyGems implements Statement {
@@ -31,10 +31,6 @@ import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
/**
*
* @author Adrian Cole
*/
public class AuthorizeRSAPublicKeys implements Statement {
private final String sshDir;
private final List<String> publicKeys;
@@ -28,10 +28,6 @@ import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
/**
*
* @author Adrian Cole
*/
public class InstallRSAPrivateKey implements Statement {
private final String sshDir;
private final String privateKey;
@@ -24,8 +24,6 @@ import com.google.common.collect.ImmutableMap;
/**
* Statements used in ssh control
*
* @author Adrian Cole
*/
public class SshStatements {
@@ -30,8 +30,6 @@ import com.google.common.collect.ImmutableList;
/**
* Control sshd_config
*
* @author Adrian Cole
*/
public class SshdConfig implements Statement {
private static final String sshdConfig = "/etc/ssh/sshd_config";
@@ -35,8 +35,6 @@ import static com.google.common.base.Preconditions.checkNotNull;
/**
* Utilities used to build init scripts.
*
* @author Adrian Cole
*/
public class Utils {
@@ -31,8 +31,6 @@ import com.google.common.io.Resources;
/**
* Tests possible uses of EnvBuilder
*
* @author Adrian Cole
*/
public class EnvBuilderTest {
@@ -36,8 +36,6 @@ import com.google.common.io.Resources;
/**
* Tests possible uses of InitScript
*
* @author Adrian Cole
*/
public class InitScriptTest {
InitScript testInitScript = InitScript
@@ -44,8 +44,6 @@ import com.google.common.io.Resources;
/**
* Tests possible uses of ScriptBuilder
*
* @author Adrian Cole
*/
public class ScriptBuilderTest {
@@ -27,9 +27,6 @@ import com.google.common.base.Charsets;
import com.google.common.collect.ImmutableList;
import com.google.common.io.Resources;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class AppendFileTest {
Statement statement = appendFile("{root}etc{fs}chef{fs}client.rb", ImmutableList.of("log_level :info",
@@ -20,9 +20,6 @@ import static org.testng.Assert.assertEquals;
import org.testng.annotations.Test;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class CallTest {
@@ -27,9 +27,6 @@ import com.google.common.base.Charsets;
import com.google.common.collect.ImmutableList;
import com.google.common.io.Resources;
/**
* @author Karel Vervaeke
*/
@Test(groups = "unit")
public class CreateOrOverwriteFileTest {
Statement statement = createOrOverwriteFile("{root}etc{fs}chef{fs}client.rb", ImmutableList.of("log_level :info",
@@ -29,9 +29,6 @@ import com.google.common.base.Charsets;
import com.google.common.collect.ImmutableList;
import com.google.common.io.Resources;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class CreateRunScriptTest {
Statement statement = createRunScript(
@@ -24,9 +24,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMultimap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class PipeHttpResponseToTest {
PipeHttpResponseTo bash = new PipeHttpResponseTo(Statements.interpret("bash"), "GET", URI
@@ -24,9 +24,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMultimap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit", testName = "SaveHttpResponseToTest")
public class SaveHttpResponseToTest {
@@ -24,9 +24,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class ShellTokenTest {
@@ -23,9 +23,6 @@ import static org.testng.Assert.assertEquals;
import org.testng.annotations.Test;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class StatementListTest {
Statement statement = newStatementList(call("default"), interpret("echo started{lf}"));
@@ -22,9 +22,6 @@ import java.net.URI;
import org.testng.annotations.Test;
/**
* @author Adrian Cole
*/
@Test(groups = "unit", testName = "StatementsTest")
public class StatementsTest {
@@ -26,9 +26,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class SwitchArgTest {
@@ -24,9 +24,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMultimap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class UnzipHttpResponseIntoDirectoryToTest {
@@ -22,8 +22,6 @@ import org.testng.annotations.Test;
/**
* Unit tests for the {@link Role} class.
*
* @author Ignasi Barrera
*/
@Test(groups = "unit", testName = "RoleTest")
public class RoleTest {
@@ -22,8 +22,6 @@ import org.testng.annotations.Test;
/**
* Unit tests for the {@link RunList} class.
*
* @author Ignasi Barrera
*/
@Test(groups = "unit", testName = "RunListTest")
public class RunListTest {
@@ -31,9 +31,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class CredentialsFromAdminAccessTest {
@@ -28,9 +28,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class InitAdminAccessTest {
@@ -35,8 +35,6 @@ import com.google.common.collect.ImmutableSet;
/**
* Unit tests for the {@link ChefSoloTest} statement.
*
* @author Ignasi Barrera
*/
@Test(groups = "unit", testName = "ChefSoloTest")
public class ChefSoloTest {
@@ -30,8 +30,6 @@ import com.google.common.io.Resources;
/**
* Unit tests for the {@link InstallChefGems} statement.
*
* @author Ignasi Barrera
*/
@Test(groups = "unit", testName = "InstallChefGemsTest")
public class InstallChefGemsTest {
@@ -30,8 +30,6 @@ import com.google.common.io.Resources;
/**
* Unit tests for the {@link InstallChefUsingOmnibus} statement.
*
* @author Ignasi Barrera
*/
@Test(groups = "unit", testName = "InstallChefClientUsingOmnibusTest")
public class InstallChefUsingOmnibusTest {
@@ -21,9 +21,6 @@ import static org.testng.Assert.assertEquals;
import org.jclouds.scriptbuilder.domain.OsFamily;
import org.testng.annotations.Test;
/**
* @author Adrian Cole
*/
@Test(groups = "unit", testName = "CloneGitRepoTest")
public class CloneGitRepoTest {
@@ -28,9 +28,6 @@ import org.testng.annotations.Test;
import com.google.common.base.Charsets;
import com.google.common.io.Resources;
/**
* @author Adrian Cole
*/
@Test(groups = "unit", testName = "InstallGitTest")
public class InstallGitTest {
@@ -30,9 +30,6 @@ import org.testng.annotations.Test;
import com.google.common.base.Charsets;
import com.google.common.io.Resources;
/**
* @author Adrian Cole
*/
@Test(groups = "unit", testName = "InstallJDKTest")
public class InstallJDKTest {
@@ -36,8 +36,6 @@ import com.google.gson.Gson;
*
* <p/>
* inspired by guava {@code CacheBuilderSpecTest}
*
* @author David Alves
*/
@Test(testName = "AdminAccessBuilderSpecTest")
public class AdminAccessBuilderSpecTest {
@@ -26,9 +26,6 @@ import org.testng.annotations.Test;
import com.google.common.base.Charsets;
import com.google.common.io.Resources;
/**
* @author Adrian Cole
*/
@Test(groups = "unit", singleThreaded = true, testName = "AdminAccessTest")
public class AdminAccessTest {
@@ -23,9 +23,6 @@ import org.testng.annotations.Test;
import com.google.common.base.Function;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class ReplaceShadowPasswordEntryOfLoginUserTest {
Function<String, String> crypt = new Function<String, String>() {
@@ -23,9 +23,6 @@ import org.testng.annotations.Test;
import com.google.common.base.Function;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class ReplaceShadowPasswordEntryTest {
Function<String, String> crypt = new Function<String, String>() {
@@ -21,9 +21,6 @@ import static org.testng.Assert.assertEquals;
import org.jclouds.scriptbuilder.domain.OsFamily;
import org.testng.annotations.Test;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class SudoStatementsTest {
@@ -25,11 +25,6 @@ import com.google.common.base.Supplier;
import com.google.common.base.Suppliers;
import com.google.common.collect.ImmutableMap;
/**
*
* @author Adrian Cole
*
*/
public enum TestConfiguration implements Configuration {
INSTANCE;
int pwCount = 0;
@@ -24,9 +24,6 @@ import org.testng.annotations.Test;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableList;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class UserAddTest {
@@ -31,8 +31,6 @@ import com.google.common.io.Resources;
/**
* Unit tests for the {@link InstallRubyGemsTest} statement.
*
* @author Ignasi Barrera
*/
@Test(groups = "unit", testName = "InstallRubyGemsTest")
public class InstallRubyGemsTest {
@@ -30,8 +30,6 @@ import com.google.common.io.Resources;
/**
* Unit tests for the {@link InstallRuby} statement.
*
* @author Ignasi Barrera
*/
@Test(groups = "unit", testName = "InstallRubyTest")
public class InstallRubyTest {
@@ -23,9 +23,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableSet;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class AuthorizeRSAPublicKeyTest {
@@ -21,9 +21,6 @@ import static org.testng.Assert.assertEquals;
import org.jclouds.scriptbuilder.domain.OsFamily;
import org.testng.annotations.Test;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class InstallRSAPrivateKeyTest {
@@ -23,9 +23,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableMap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class SshStatementsTest {
@@ -25,9 +25,6 @@ import org.testng.annotations.Test;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
/**
* @author Adrian Cole
*/
@Test(groups = "unit")
public class UtilsTest {