From 1d78b8b372f15d89f10fd32cb0227a6a7966de3c Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Thu, 17 Apr 2014 23:08:07 -0400
Subject: [PATCH] [findbugs] Clarify class used for resource loading
---
src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java | 51 +++++++++++++++++++++++++++++++++++++--------------
1 files changed, 37 insertions(+), 14 deletions(-)
diff --git a/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java b/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
index 6e9a87d..6683e21 100644
--- a/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
+++ b/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
@@ -1,17 +1,19 @@
-// Copyright (C) 2009 The Android Open Source Project
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+/*
+ * Copyright (C) 2009 The Android Open Source Project
+ * Copyright 2014 gitblit.com.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package com.gitblit.transport.ssh.commands;
import java.io.IOException;
@@ -40,6 +42,12 @@
import com.google.common.base.Strings;
import com.google.common.collect.Maps;
+/**
+ * Parses an SSH command-line and dispatches the command to the appropriate
+ * BaseCommand instance.
+ *
+ * @since 1.5.0
+ */
public abstract class DispatchCommand extends BaseCommand implements ExtensionPoint {
private Logger log = LoggerFactory.getLogger(getClass());
@@ -89,6 +97,7 @@
* registered within this method.
*
* @param user
+ * @since 1.5.0
*/
protected abstract void setup(UserModel user);
@@ -318,6 +327,10 @@
return false;
}
+ public String getDescription() {
+ return getClass().getAnnotation(CommandMetaData.class).description();
+ }
+
@Override
public String usage() {
Set<String> cmds = new TreeSet<String>();
@@ -351,6 +364,16 @@
String format = "%-" + maxLength + "s %s";
final StringBuilder usage = new StringBuilder();
+ if (!StringUtils.isEmpty(getName())) {
+ String title = getName().toUpperCase() + ": " + getDescription();
+ String b = com.gitblit.utils.StringUtils.leftPad("", title.length() + 2, '═');
+ usage.append('\n');
+ usage.append(b).append('\n');
+ usage.append(' ').append(title).append('\n');
+ usage.append(b).append('\n');
+ usage.append('\n');
+ }
+
if (!cmds.isEmpty()) {
usage.append("Available commands");
if (!getName().isEmpty()) {
--
Gitblit v1.9.1