You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2016/09/28 12:44:04 UTC
svn commit: r1762638 -
/tomcat/trunk/java/org/apache/catalina/util/LifecycleBase.java
Author: markt
Date: Wed Sep 28 12:44:04 2016
New Revision: 1762638
URL: http://svn.apache.org/viewvc?rev=1762638&view=rev
Log:
Add some Javadoc
Reduce whitespace
Use longer lines where possible
Modified:
tomcat/trunk/java/org/apache/catalina/util/LifecycleBase.java
Modified: tomcat/trunk/java/org/apache/catalina/util/LifecycleBase.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/LifecycleBase.java?rev=1762638&r1=1762637&r2=1762638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/LifecycleBase.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/LifecycleBase.java Wed Sep 28 12:44:04 2016
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.catalina.util;
import java.util.List;
@@ -30,7 +29,6 @@ import org.apache.juli.logging.LogFactor
import org.apache.tomcat.util.ExceptionUtils;
import org.apache.tomcat.util.res.StringManager;
-
/**
* Base implementation of the {@link Lifecycle} interface that implements the
* state transition rules for {@link Lifecycle#start()} and
@@ -109,14 +107,20 @@ public abstract class LifecycleBase impl
} catch (Throwable t) {
ExceptionUtils.handleThrowable(t);
setStateInternal(LifecycleState.FAILED, null, false);
- throw new LifecycleException(
- sm.getString("lifecycleBase.initFail",toString()), t);
+ throw new LifecycleException(sm.getString("lifecycleBase.initFail",toString()), t);
}
}
+ /**
+ * Sub-classes implement this method to perform any instance initialisation
+ * required.
+ *
+ * @throws LifecycleException If the initialisation fails
+ */
protected abstract void initInternal() throws LifecycleException;
+
/**
* {@inheritDoc}
*/
@@ -269,9 +273,7 @@ public abstract class LifecycleBase impl
}
}
- if (LifecycleState.DESTROYING.equals(state) ||
- LifecycleState.DESTROYED.equals(state)) {
-
+ if (LifecycleState.DESTROYING.equals(state) || LifecycleState.DESTROYED.equals(state)) {
if (log.isDebugEnabled()) {
Exception e = new LifecycleException();
log.debug(sm.getString("lifecycleBase.alreadyDestroyed", toString()), e);
@@ -285,10 +287,8 @@ public abstract class LifecycleBase impl
return;
}
- if (!state.equals(LifecycleState.STOPPED) &&
- !state.equals(LifecycleState.FAILED) &&
- !state.equals(LifecycleState.NEW) &&
- !state.equals(LifecycleState.INITIALIZED)) {
+ if (!state.equals(LifecycleState.STOPPED) && !state.equals(LifecycleState.FAILED) &&
+ !state.equals(LifecycleState.NEW) && !state.equals(LifecycleState.INITIALIZED)) {
invalidTransition(Lifecycle.BEFORE_DESTROY_EVENT);
}
@@ -299,14 +299,20 @@ public abstract class LifecycleBase impl
} catch (Throwable t) {
ExceptionUtils.handleThrowable(t);
setStateInternal(LifecycleState.FAILED, null, false);
- throw new LifecycleException(
- sm.getString("lifecycleBase.destroyFail",toString()), t);
+ throw new LifecycleException(sm.getString("lifecycleBase.destroyFail",toString()), t);
}
}
+ /**
+ * Sub-classes implement this method to perform any instance destruction
+ * required.
+ *
+ * @throws LifecycleException If the destruction fails
+ */
protected abstract void destroyInternal() throws LifecycleException;
+
/**
* {@inheritDoc}
*/
@@ -334,8 +340,7 @@ public abstract class LifecycleBase impl
* @param state The new state for this component
* @throws LifecycleException when attempting to set an invalid state
*/
- protected synchronized void setState(LifecycleState state)
- throws LifecycleException {
+ protected synchronized void setState(LifecycleState state) throws LifecycleException {
setStateInternal(state, null, true);
}
@@ -355,8 +360,9 @@ public abstract class LifecycleBase impl
setStateInternal(state, data, true);
}
- private synchronized void setStateInternal(LifecycleState state,
- Object data, boolean check) throws LifecycleException {
+
+ private synchronized void setStateInternal(LifecycleState state, Object data, boolean check)
+ throws LifecycleException {
if (log.isDebugEnabled()) {
log.debug(sm.getString("lifecycleBase.setState", this, state));
@@ -396,9 +402,9 @@ public abstract class LifecycleBase impl
}
}
+
private void invalidTransition(String type) throws LifecycleException {
- String msg = sm.getString("lifecycleBase.invalidTransition", type,
- toString(), state);
+ String msg = sm.getString("lifecycleBase.invalidTransition", type, toString(), state);
throw new LifecycleException(msg);
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org