View Javadoc
1   /*
2    * Copyright (C) 2008-2010, Google Inc.
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  
44  package org.eclipse.jgit.transport;
45  
46  import java.io.IOException;
47  import java.io.OutputStream;
48  
49  import org.eclipse.jgit.lib.BatchingProgressMonitor;
50  import org.eclipse.jgit.lib.Constants;
51  
52  /** Write progress messages out to the sideband channel. */
53  class SideBandProgressMonitor extends BatchingProgressMonitor {
54  	private final OutputStream out;
55  
56  	private boolean write;
57  
58  	SideBandProgressMonitor(OutputStream os) {
59  		out = os;
60  		write = true;
61  	}
62  
63  	/** {@inheritDoc} */
64  	@Override
65  	protected void onUpdate(String taskName, int workCurr) {
66  		StringBuilder s = new StringBuilder();
67  		format(s, taskName, workCurr);
68  		s.append("   \r"); //$NON-NLS-1$
69  		send(s);
70  	}
71  
72  	/** {@inheritDoc} */
73  	@Override
74  	protected void onEndTask(String taskName, int workCurr) {
75  		StringBuilder s = new StringBuilder();
76  		format(s, taskName, workCurr);
77  		s.append(", done\n"); //$NON-NLS-1$
78  		send(s);
79  	}
80  
81  	private void format(StringBuilder s, String taskName, int workCurr) {
82  		s.append(taskName);
83  		s.append(": "); //$NON-NLS-1$
84  		s.append(workCurr);
85  	}
86  
87  	/** {@inheritDoc} */
88  	@Override
89  	protected void onUpdate(String taskName, int cmp, int totalWork, int pcnt) {
90  		StringBuilder s = new StringBuilder();
91  		format(s, taskName, cmp, totalWork, pcnt);
92  		s.append("   \r"); //$NON-NLS-1$
93  		send(s);
94  	}
95  
96  	/** {@inheritDoc} */
97  	@Override
98  	protected void onEndTask(String taskName, int cmp, int totalWork, int pcnt) {
99  		StringBuilder s = new StringBuilder();
100 		format(s, taskName, cmp, totalWork, pcnt);
101 		s.append("\n"); //$NON-NLS-1$
102 		send(s);
103 	}
104 
105 	private void format(StringBuilder s, String taskName, int cmp,
106 			int totalWork, int pcnt) {
107 		s.append(taskName);
108 		s.append(": "); //$NON-NLS-1$
109 		if (pcnt < 100)
110 			s.append(' ');
111 		if (pcnt < 10)
112 			s.append(' ');
113 		s.append(pcnt);
114 		s.append("% ("); //$NON-NLS-1$
115 		s.append(cmp);
116 		s.append("/"); //$NON-NLS-1$
117 		s.append(totalWork);
118 		s.append(")"); //$NON-NLS-1$
119 	}
120 
121 	private void send(StringBuilder s) {
122 		if (write) {
123 			try {
124 				out.write(Constants.encode(s.toString()));
125 				out.flush();
126 			} catch (IOException err) {
127 				write = false;
128 			}
129 		}
130 	}
131 }