Coverage Report

Coverage Report - org.apache.turbine.services.BaseInitable

Classes in this File

Line Coverage

Branch Coverage

Complexity

BaseInitable

46%

6/13

N/A

 package org.apache.turbine.services;
 
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 
 /**
  * This class provides a generic implementation of
  * <code>Initable</code>.  This implementation, that other
  * <code>Initables</code> are welcome to extend, contains facilities
  * to maintain internal state.
  *
  * @author <a href="mailto:burton@apache.org">Kevin Burton</a>
  * @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a>
  * @version $Id: BaseInitable.java 1773378 2016-12-09 13:19:59Z tv $
  */
 public class BaseInitable
         implements Initable
 {
     /** InitableBroker that instantiatd this class. */
     protected InitableBroker initableBroker;
 
     /** Initialization status of this class. */
     protected boolean isInitialized = false;
 
     /**
      * Default constructor of BaseInitable.
      *
      * This constructor does nothing.  Your own constructurs should be
      * modest in allocating memory and other resources, leaving this
      * to the <code>init()</code> method.
      */
     public BaseInitable()
     {
         // empty
     }
 
     /**
      * Saves InitableBroker reference for later use.
      *
      * @param broker The InitableBroker that instantiated this object.
      */
     @Override
     public void setInitableBroker(InitableBroker broker)
     {
         this.initableBroker = broker;
     }
 
     /**
      * Returns an InitableBroker reference.
      *
      * @return The InitableBroker that instantiated this object.
      */
     public InitableBroker getInitableBroker()
     {
         return initableBroker;
     }
 
     /**
      * Performs early initialization.  Used in a manner similar to a ctor.
      *
      * BaseInitable doesn't need early initialization, therefore it
      * ignores all objects passed to it and performs no initialization
      * activities.
      *
      * @param data An Object to use for initialization activities.
      * @throws InitializationException Initialization of this
      * class was not successful.
      */
     @Override
     public void init(Object data) throws InitializationException
     {
         // empty
     }
 
     /**
      * Performs late initialization.  Called when the Service is requested
      * for the first time (if not already completely initialized by the
      * early initializer).
      *
      * Late initialization of a BaseInitable is always successful.
      *
      * @throws InitializationException Initialization of this
      * class was not successful.
      */
     @Override
     public void init() throws InitializationException
     {
         // empty
     }
 
     /**
      * Returns an Initable to uninitialized state.
      *
      * Calls setInit(false) to mark that we are no longer in initialized
      * state.
      */
     @Override
     public void shutdown()
     {
         setInit(false);
     }
 
     /**
      * Returns initialization status.
      *
      * @return True if the initable is initialized.
      */
     @Override
     public boolean getInit()
     {
         return isInitialized;
     }
 
     /**
      * Sets initialization status.
      *
      * @param value The new initialization status.
      */
     protected void setInit(boolean value)
     {
         this.isInitialized = value;
     }
 }

1		package org.apache.turbine.services;
2
3
4		/*
5		* Licensed to the Apache Software Foundation (ASF) under one
6		* or more contributor license agreements. See the NOTICE file
7		* distributed with this work for additional information
8		* regarding copyright ownership. The ASF licenses this file
9		* to you under the Apache License, Version 2.0 (the
10		* "License"); you may not use this file except in compliance
11		* with the License. You may obtain a copy of the License at
12		*
13		* http://www.apache.org/licenses/LICENSE-2.0
14		*
15		* Unless required by applicable law or agreed to in writing,
16		* software distributed under the License is distributed on an
17		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18		* KIND, either express or implied. See the License for the
19		* specific language governing permissions and limitations
20		* under the License.
21		*/
22
23
24		/**
25		* This class provides a generic implementation of
26		* <code>Initable</code>. This implementation, that other
27		* <code>Initables</code> are welcome to extend, contains facilities
28		* to maintain internal state.
29		*
30		* @author <a href="mailto:burton@apache.org">Kevin Burton</a>
31		* @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a>
32		* @version $Id: BaseInitable.java 1773378 2016-12-09 13:19:59Z tv $
33		*/
34		public class BaseInitable
35		implements Initable
36		{
37		/** InitableBroker that instantiatd this class. */
38		protected InitableBroker initableBroker;
39
40		/** Initialization status of this class. */
41	289	protected boolean isInitialized = false;
42
43		/**
44		* Default constructor of BaseInitable.
45		*
46		* This constructor does nothing. Your own constructurs should be
47		* modest in allocating memory and other resources, leaving this
48		* to the <code>init()</code> method.
49		*/
50		public BaseInitable()
51	289	{
52		// empty
53	289	}
54
55		/**
56		* Saves InitableBroker reference for later use.
57		*
58		* @param broker The InitableBroker that instantiated this object.
59		*/
60		@Override
61		public void setInitableBroker(InitableBroker broker)
62		{
63	0	this.initableBroker = broker;
64	0	}
65
66		/**
67		* Returns an InitableBroker reference.
68		*
69		* @return The InitableBroker that instantiated this object.
70		*/
71		public InitableBroker getInitableBroker()
72		{
73	0	return initableBroker;
74		}
75
76		/**
77		* Performs early initialization. Used in a manner similar to a ctor.
78		*
79		* BaseInitable doesn't need early initialization, therefore it
80		* ignores all objects passed to it and performs no initialization
81		* activities.
82		*
83		* @param data An Object to use for initialization activities.
84		* @throws InitializationException Initialization of this
85		* class was not successful.
86		*/
87		@Override
88		public void init(Object data) throws InitializationException
89		{
90		// empty
91	0	}
92
93		/**
94		* Performs late initialization. Called when the Service is requested
95		* for the first time (if not already completely initialized by the
96		* early initializer).
97		*
98		* Late initialization of a BaseInitable is always successful.
99		*
100		* @throws InitializationException Initialization of this
101		* class was not successful.
102		*/
103		@Override
104		public void init() throws InitializationException
105		{
106		// empty
107	0	}
108
109		/**
110		* Returns an Initable to uninitialized state.
111		*
112		* Calls setInit(false) to mark that we are no longer in initialized
113		* state.
114		*/
115		@Override
116		public void shutdown()
117		{
118	0	setInit(false);
119	0	}
120
121		/**
122		* Returns initialization status.
123		*
124		* @return True if the initable is initialized.
125		*/
126		@Override
127		public boolean getInit()
128		{
129	5063	return isInitialized;
130		}
131
132		/**
133		* Sets initialization status.
134		*
135		* @param value The new initialization status.
136		*/
137		protected void setInit(boolean value)
138		{
139	623	this.isInitialized = value;
140	623	}
141		}