View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core;
18  
19  import java.io.Serializable;
20  
21  import org.apache.logging.log4j.status.StatusLogger;
22  
23  /**
24   * A life cycle to be extended.
25   * <p>
26   * Wraps a {@link LifeCycle.State}.
27   * </p>
28   */
29  public class AbstractLifeCycle implements LifeCycle, Serializable {
30  
31      /**
32       * Allow subclasses access to the status logger without creating another instance.
33       */
34      protected static final org.apache.logging.log4j.Logger LOGGER = StatusLogger.getLogger();
35  
36      private static final long serialVersionUID = 1L;
37  
38      private volatile LifeCycle.State state = LifeCycle.State.INITIALIZED;
39  
40      @Override
41      public boolean equals(final Object obj) {
42          if (this == obj) {
43              return true;
44          }
45          if (obj == null) {
46              return false;
47          }
48          if (getClass() != obj.getClass()) {
49              return false;
50          }
51          final AbstractLifeCycle other = (AbstractLifeCycle) obj;
52          if (state != other.state) {
53              return false;
54          }
55          return true;
56      }
57  
58      public LifeCycle.State getState() {
59          return this.state;
60      }
61  
62      @Override
63      public int hashCode() {
64          final int prime = 31;
65          int result = 1;
66          result = prime * result + ((state == null) ? 0 : state.hashCode());
67          return result;
68      }
69  
70      public boolean isInitialized() {
71          return this.state == LifeCycle.State.INITIALIZED;
72      }
73  
74      @Override
75      public boolean isStarted() {
76          return this.state == LifeCycle.State.STARTED;
77      }
78  
79      public boolean isStarting() {
80          return this.state == LifeCycle.State.STARTING;
81      }
82  
83      @Override
84      public boolean isStopped() {
85          return this.state == LifeCycle.State.STOPPED;
86      }
87  
88      public boolean isStopping() {
89          return this.state == LifeCycle.State.STOPPING;
90      }
91  
92      protected void setStarted() {
93          this.setState(LifeCycle.State.STARTED);
94      }
95  
96      protected void setStarting() {
97          this.setState(LifeCycle.State.STARTING);
98      }
99  
100     protected void setState(final LifeCycle.State newState) {
101         this.state = newState;
102         // Need a better string than this.toString() for the message
103         // LOGGER.debug("{} {}", this.state, this);
104     }
105 
106     protected void setStopped() {
107         this.setState(LifeCycle.State.STOPPED);
108     }
109 
110     protected void setStopping() {
111         this.setState(LifeCycle.State.STOPPING);
112     }
113 
114     @Override
115     public void start() {
116         this.setStarted();
117     }
118 
119     @Override
120     public void stop() {
121         this.state = LifeCycle.State.STOPPED;
122     }
123 
124 }