View Javadoc
1   /*
2    * (c) Copyright 2006-2020 by rapiddweller GmbH & Volker Bergmann. All rights reserved.
3    *
4    * Redistribution and use in source and binary forms, with or without
5    * modification, is permitted under the terms of the
6    * GNU General Public License.
7    *
8    * For redistributing this software or a derivative work under a license other
9    * than the GPL-compatible Free Software License as defined by the Free
10   * Software Foundation or approved by OSI, you must first obtain a commercial
11   * license to this software product from rapiddweller GmbH & Volker Bergmann.
12   *
13   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14   * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
15   * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
17   * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24   * POSSIBILITY OF SUCH DAMAGE.
25   */
26  
27  package com.rapiddweller.benerator.util;
28  
29  import com.rapiddweller.benerator.Generator;
30  import com.rapiddweller.benerator.GeneratorContext;
31  import com.rapiddweller.benerator.GeneratorState;
32  import com.rapiddweller.benerator.IllegalGeneratorStateException;
33  import com.rapiddweller.benerator.wrapper.ProductWrapper;
34  import com.rapiddweller.common.BeanUtil;
35  import org.apache.logging.log4j.LogManager;
36  import org.apache.logging.log4j.Logger;
37  
38  /**
39   * Abstract {@link Generator} implementation which holds a state and state management methods.<br/><br/>
40   * Created: 24.02.2010 12:28:05
41   *
42   * @param <E> the type parameter
43   * @author Volker Bergmann
44   * @since 0.6.0
45   */
46  public abstract class AbstractGenerator<E> implements Generator<E> {
47  
48    /**
49     * The Logger.
50     */
51    protected final Logger logger = LogManager.getLogger(getClass());
52    private final WrapperProvider<E> resultWrapperProvider;
53    /**
54     * The State.
55     */
56    protected GeneratorState state;
57    /**
58     * The Context.
59     */
60    protected GeneratorContext context;
61  
62    /**
63     * Instantiates a new Abstract generator.
64     */
65    public AbstractGenerator() {
66      this.state = GeneratorState.CREATED;
67      this.resultWrapperProvider = new WrapperProvider<>();
68    }
69  
70    @Override
71    public synchronized void init(GeneratorContext context) {
72      this.context = context;
73      this.state = GeneratorState.RUNNING;
74    }
75  
76    @Override
77    public boolean wasInitialized() {
78      return (state != GeneratorState.CREATED);
79    }
80  
81    @Override
82    public void reset() {
83      this.state = GeneratorState.RUNNING;
84    }
85  
86    @Override
87    public void close() {
88      this.state = GeneratorState.CLOSED;
89    }
90  
91    // internal helpers ------------------------------------------------------------------------------------------------
92  
93    /**
94     * Assert not initialized.
95     */
96    protected final void assertNotInitialized() {
97      if (state != GeneratorState.CREATED) {
98        if (state == GeneratorState.RUNNING) {
99          throw new IllegalGeneratorStateException("Trying to initialize generator a 2nd time: " + this);
100       } else {
101         throw new IllegalGeneratorStateException("Trying to initialize generator in '" + state + "' state: " + this);
102       }
103     }
104   }
105 
106   /**
107    * Assert initialized.
108    */
109   protected final void assertInitialized() {
110     if (state == GeneratorState.CREATED) {
111       throw new IllegalGeneratorStateException("Generator has not been initialized: " + this);
112     }
113     if (state == GeneratorState.CLOSED) {
114       throw new IllegalGeneratorStateException("Generator has already been closed: " + this);
115     }
116   }
117 
118   /**
119    * Gets result wrapper.
120    *
121    * @return the result wrapper
122    */
123   protected ProductWrapper<E> getResultWrapper() {
124     return resultWrapperProvider.get();
125   }
126 
127   // java.lang.Object overrides --------------------------------------------------------------------------------------
128 
129   @Override
130   public String toString() {
131     return (state == GeneratorState.RUNNING ? BeanUtil.toString(this) : getClass().getSimpleName());
132   }
133 
134 }