some annotations added
[idea/community.git] / platform / platform-api / src / com / intellij / execution / process / ProcessOutput.java
1 /*
2  * Copyright 2000-2014 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.execution.process;
17
18 import com.intellij.openapi.diagnostic.Logger;
19 import com.intellij.openapi.util.text.StringUtil;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 import java.util.List;
24
25 /**
26  * @author yole
27  */
28 public class ProcessOutput {
29   private final StringBuilder myStdoutBuilder = new StringBuilder();
30   private final StringBuilder myStderrBuilder = new StringBuilder();
31   private int myExitCode;
32   private boolean myTimeout;
33   private boolean myCancelled;
34
35   public ProcessOutput() {
36     myExitCode = -1; // until set explicitly, exit code denotes an error.
37   }
38
39   public ProcessOutput(final int exitCode) {
40     myExitCode = exitCode;
41   }
42
43   public void appendStdout(@Nullable String text) {
44     myStdoutBuilder.append(text);
45   }
46
47   public void appendStderr(@Nullable String text) {
48     myStderrBuilder.append(text);
49   }
50
51   @NotNull
52   public String getStdout() {
53     return myStdoutBuilder.toString();
54   }
55
56   @NotNull
57   public String getStderr() {
58     return myStderrBuilder.toString();
59   }
60
61   @NotNull
62   public List<String> getStdoutLines() {
63     return splitLines(getStdout());
64   }
65
66   @NotNull
67   public List<String> getStderrLines() {
68     return splitLines(getStderr());
69   }
70
71   @NotNull
72   private static List<String> splitLines(String s) {
73     String converted = StringUtil.convertLineSeparators(s);
74     return StringUtil.split(converted, "\n");
75   }
76
77   /**
78    * If exit code is nonzero or the process timed out, logs stderr and exit code and returns false,
79    * else just returns true.
80    *
81    * @param logger where to put error information
82    * @return true iff exit code is zero
83    */
84   public boolean checkSuccess(@NotNull final Logger logger) {
85     if (getExitCode() != 0 || isTimeout()) {
86       logger.info(getStderr() + (isTimeout()? "\nTimed out" : "\nExit code " + getExitCode()));
87       return false;
88     }
89     return true;
90   }
91
92   public void setExitCode(int exitCode) {
93     myExitCode = exitCode;
94   }
95
96   public int getExitCode() {
97     return myExitCode;
98   }
99
100   public void setTimeout() {
101     myTimeout = true;
102   }
103
104   public boolean isTimeout() {
105     return myTimeout;
106   }
107
108   public void setCancelled() {
109     myCancelled = true;
110   }
111
112   public boolean isCancelled() {
113     return myCancelled;
114   }
115 }