From bba53939c8d7e5d9bebe5a3d70cf04b3a51f0701 Mon Sep 17 00:00:00 2001 From: Peter Reilly Date: Fri, 10 Nov 2006 22:55:30 +0000 Subject: [PATCH] checkstyle git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@473560 13f79535-47bb-0310-9956-ffa450edef68 --- .../taskdefs/optional/perforce/P4Base.java | 43 +++++++++++-------- .../taskdefs/optional/perforce/P4Change.java | 2 + .../taskdefs/optional/perforce/P4Counter.java | 3 ++ .../taskdefs/optional/perforce/P4Delete.java | 2 + .../taskdefs/optional/perforce/P4Edit.java | 3 ++ .../optional/perforce/P4HandlerAdapter.java | 7 ++- .../taskdefs/optional/perforce/P4Label.java | 2 + .../optional/perforce/P4Labelsync.java | 2 + .../taskdefs/optional/perforce/P4Submit.java | 8 +++- .../taskdefs/optional/perforce/P4Sync.java | 2 + .../perforce/SimpleP4OutputHandler.java | 2 + 11 files changed, 54 insertions(+), 22 deletions(-) diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java index fc6cee2cc..98458fe4c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java @@ -42,7 +42,8 @@ import org.apache.tools.ant.types.Commandline; * @see org.apache.tools.ant.taskdefs.Execute */ public abstract class P4Base extends org.apache.tools.ant.Task { - + // CheckStyle:VisibilityModifier OFF - bc + // CheckStyle:MemberNameCheck OFF - bc /**Perl5 regexp in Java - cool eh? */ protected Perl5Util util = null; /** The OS shell to use (cmd.exe or /bin/sh) */ @@ -76,6 +77,10 @@ public abstract class P4Base extends org.apache.tools.ant.Task { /** If inError is set, then errorMessage needs to contain the reason why. */ private String errorMessage = ""; + + // CheckStyle:MemberNameCheck ON + // CheckStyle:VisibilityModifier ON + /** * gets whether or not the task has encountered an error * @return error flag @@ -115,39 +120,39 @@ public abstract class P4Base extends org.apache.tools.ant.Task { * The p4d server and port to connect to; * optional, default "perforce:1666" * - * @param P4Port the port one wants to set such as localhost:1666 + * @param p4Port the port one wants to set such as localhost:1666 */ - public void setPort(String P4Port) { - this.P4Port = "-p" + P4Port; + public void setPort(String p4Port) { + this.P4Port = "-p" + p4Port; } /** * The p4 client spec to use; * optional, defaults to the current user * - * @param P4Client the name of the Perforce client spec + * @param p4Client the name of the Perforce client spec */ - public void setClient(String P4Client) { - this.P4Client = "-c" + P4Client; + public void setClient(String p4Client) { + this.P4Client = "-c" + p4Client; } /** * The p4 username; * optional, defaults to the current user * - * @param P4User the user name + * @param p4User the user name */ - public void setUser(String P4User) { - this.P4User = "-u" + P4User; + public void setUser(String p4User) { + this.P4User = "-u" + p4User; } /** * Set global P4 options; Used on all * of the Perforce tasks. * - * @param P4Opts global options, to use a specific P4Config file for instance + * @param p4Opts global options, to use a specific P4Config file for instance */ - public void setGlobalopts(String P4Opts) { - this.P4Opts = P4Opts; + public void setGlobalopts(String p4Opts) { + this.P4Opts = p4Opts; } /** * The client, branch or label view to operate upon; @@ -161,21 +166,21 @@ public abstract class P4Base extends org.apache.tools.ant.Task { *
  • p4resolve
    • * * - * @param P4View the view one wants to use + * @param p4View the view one wants to use */ - public void setView(String P4View) { - this.P4View = P4View; + public void setView(String p4View) { + this.P4View = p4View; } /** * Set extra command options; only used on some * of the Perforce tasks. * - * @param P4CmdOpts command line options going after the particular + * @param p4CmdOpts command line options going after the particular * Perforce command */ - public void setCmdopts(String P4CmdOpts) { - this.P4CmdOpts = P4CmdOpts; + public void setCmdopts(String p4CmdOpts) { + this.P4CmdOpts = p4CmdOpts; } /** diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java index 462d07fce..c9cf3ef6b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java @@ -39,9 +39,11 @@ import org.apache.tools.ant.Project; * @ant.task category="scm" */ public class P4Change extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc protected String emptyChangeList = null; protected String description = "AutoSubmit By Ant"; + // CheckStyle:VisibilityModifier ON /** * creates a new Perforce change list diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java index ae27b71c4..2fd13f5c7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java @@ -49,6 +49,7 @@ import org.apache.tools.ant.Project; */ public class P4Counter extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc /** * name of the counter */ @@ -70,6 +71,8 @@ public class P4Counter extends P4Base { */ public int value = 0; + // CheckStyle:VisibilityModifier ON + /** * The name of the counter; required * @param counter name of the counter diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java index 25a1c7b27..0631311ea 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java @@ -33,10 +33,12 @@ import org.apache.tools.ant.BuildException; */ public class P4Delete extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc /** * number of the change list to work on */ public String change = null; + // CheckStyle:VisibilityModifier ON /** * An existing changelist number for the deletion; optional diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java index bbff0c86b..c313311d1 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java @@ -40,11 +40,14 @@ import org.apache.tools.ant.BuildException; public class P4Edit extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc /** * number of the change list to work on */ public String change = null; + // CheckStyle:VisibilityModifier ON + /** * An existing changelist number to assign files to; optional * but strongly recommended. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4HandlerAdapter.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4HandlerAdapter.java index 66adac045..3587a69a9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4HandlerAdapter.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4HandlerAdapter.java @@ -30,9 +30,10 @@ import org.apache.tools.ant.taskdefs.PumpStreamHandler; * command line client */ public abstract class P4HandlerAdapter implements P4Handler { - + // CheckStyle:VisibilityModifier OFF - bc String p4input = ""; private PumpStreamHandler myHandler = null; + // CheckStyle:VisibilityModifier ON /** * set any data to be written to P4's stdin * @param p4Input the text to write to P4's stdin @@ -50,7 +51,7 @@ public abstract class P4HandlerAdapter implements P4Handler { /** * this routine gets called by the execute routine of the Execute class * it connects the PumpStreamHandler to the input/output/error streams of the process. - * @throws BuildException + * @throws BuildException if there is a error. * @see org.apache.tools.ant.taskdefs.Execute#execute */ public void start() throws BuildException { @@ -75,9 +76,11 @@ public abstract class P4HandlerAdapter implements P4Handler { myHandler.stop(); } + // CheckStyle:VisibilityModifier OFF - bc OutputStream os; //Input InputStream is; //Output InputStream es; //Error + // CheckStyle:VisibilityModifier ON /** * connects the handler to the input stream into Perforce diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java index 3b4ad0f86..0c2edb7e3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java @@ -44,9 +44,11 @@ import org.apache.tools.ant.util.StringUtils; */ public class P4Label extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc protected String name; protected String desc; protected String lock; + // CheckStyle:VisibilityModifier ON /** * The name of the label; optional, default "AntLabel" diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java index 27a43fafa..f27c50ced 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.java @@ -42,10 +42,12 @@ import org.apache.tools.ant.util.StringUtils; */ public class P4Labelsync extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc protected String name; private boolean add; /* -a */ private boolean delete; /* -n */ private boolean simulationmode; /* -n */ + // CheckStyle:VisibilityModifier ON /** * -a flag of p4 labelsync - preserve files which exist in the label, * but not in the current view diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java index 8dae8d48d..763883c50 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java @@ -40,11 +40,13 @@ import java.util.Vector; */ public class P4Submit extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc //ToDo: If dealing with default cl need to parse out /** * change list number */ public String change; + // CheckStyle:VisibilityModifier ON /** * change property */ @@ -96,6 +98,10 @@ public class P4Submit extends P4Base { * internal class used to process the output of p4 submit */ public class P4SubmitAdapter extends SimpleP4OutputHandler { + /** + * Constructor. + * @param parent a P4Base instance. + */ public P4SubmitAdapter(P4Base parent) { super(parent); } @@ -114,7 +120,7 @@ public class P4Submit extends P4Base { util.split(myarray, line); boolean found = false; for (int counter = 0; counter < myarray.size(); counter++) { - if (found == true) { + if (found) { String chnum = (String) myarray.elementAt(counter + 1); int changenumber = Integer.parseInt(chnum); log("Perforce change renamed " + changenumber, Project.MSG_INFO); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java index fc699a6a6..e32966cb3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java @@ -50,8 +50,10 @@ import org.apache.tools.ant.Project; */ public class P4Sync extends P4Base { + // CheckStyle:VisibilityModifier OFF - bc String label; private String syncCmd = ""; + // CheckStyle:VisibilityModifier ON /** * Label to sync client to; optional. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/SimpleP4OutputHandler.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/SimpleP4OutputHandler.java index 7a6e0dff3..3e5a3cd95 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/SimpleP4OutputHandler.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/SimpleP4OutputHandler.java @@ -33,7 +33,9 @@ import org.apache.tools.ant.util.StringUtils; */ public class SimpleP4OutputHandler extends P4HandlerAdapter { + // CheckStyle:VisibilityModifier OFF - bc P4Base parent; + // CheckStyle:VisibilityModifier ON /** * simple constructor