View Javadoc
1   /*
2    * Copyright 2017 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. 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, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.ssl;
17  
18  import io.netty.util.internal.ObjectUtil;
19  
20  public abstract class SslCompletionEvent {
21  
22      private final Throwable cause;
23  
24      SslCompletionEvent() {
25          cause = null;
26      }
27  
28      SslCompletionEvent(Throwable cause) {
29          this.cause = ObjectUtil.checkNotNull(cause, "cause");
30      }
31  
32      /**
33       * Return {@code true} if the completion was successful
34       */
35      public final boolean isSuccess() {
36          return cause == null;
37      }
38  
39      /**
40       * Return the {@link Throwable} if {@link #isSuccess()} returns {@code false}
41       * and so the completion failed.
42       */
43      public final Throwable cause() {
44          return cause;
45      }
46  
47      @Override
48      public  String toString() {
49          final Throwable cause = cause();
50          return cause == null? getClass().getSimpleName() + "(SUCCESS)" :
51                  getClass().getSimpleName() +  '(' + cause + ')';
52      }
53  }