AbstractGriffonArtifact.java
001 /*
002  * Copyright 2008-2014 the original author or authors.
003  *
004  * Licensed under the Apache License, Version 2.0 (the "License");
005  * you may not use this file except in compliance with the License.
006  * You may obtain a copy of the License at
007  *
008  *     http://www.apache.org/licenses/LICENSE-2.0
009  *
010  * Unless required by applicable law or agreed to in writing, software
011  * distributed under the License is distributed on an "AS IS" BASIS,
012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013  * See the License for the specific language governing permissions and
014  * limitations under the License.
015  */
016 package org.codehaus.griffon.runtime.core.artifact;
017 
018 import griffon.core.GriffonApplication;
019 import griffon.core.artifact.GriffonArtifact;
020 import griffon.core.artifact.GriffonClass;
021 import griffon.core.artifact.GriffonController;
022 import griffon.core.artifact.GriffonModel;
023 import griffon.core.artifact.GriffonMvcArtifact;
024 import griffon.core.artifact.GriffonView;
025 import griffon.core.mvc.MVCFunction;
026 import griffon.core.mvc.MVCGroup;
027 import griffon.core.mvc.MVCGroupFunction;
028 import org.slf4j.Logger;
029 import org.slf4j.LoggerFactory;
030 
031 import javax.annotation.Nonnull;
032 import javax.annotation.Nullable;
033 import javax.annotation.concurrent.GuardedBy;
034 import javax.inject.Inject;
035 import java.io.InputStream;
036 import java.net.URL;
037 import java.util.List;
038 import java.util.Map;
039 import java.util.concurrent.Callable;
040 import java.util.concurrent.ExecutorService;
041 import java.util.concurrent.Future;
042 
043 /**
044  * Base implementation of the GriffonArtifact interface.
045  *
046  @author Andres Almiray
047  @since 2.0.0
048  */
049 public abstract class AbstractGriffonArtifact implements GriffonArtifact {
050     private final Logger log;
051     @GuardedBy("lock")
052     private GriffonClass griffonClass;
053     private final Object lock = new Object[0];
054 
055     @Inject
056     protected GriffonApplication application;
057 
058     public AbstractGriffonArtifact() {
059         log = LoggerFactory.getLogger("griffon.app." + getArtifactType() "." + getClass().getName());
060     }
061 
062     /**
063      * Creates a new instance of this class.
064      *
065      @param application the GriffonApplication that holds this artifact.
066      @deprecated Griffon prefers field injection over constructor injector for artifacts as of 2.1.0
067      */
068     @Inject
069     @Deprecated
070     public AbstractGriffonArtifact(@Nonnull GriffonApplication application) {
071         this();
072         this.application = application;
073     }
074 
075     @Nonnull
076     public GriffonApplication getApplication() {
077         return application;
078     }
079 
080     @Nonnull
081     @Override
082     @SuppressWarnings("ConstantConditions")
083     public GriffonClass getGriffonClass() {
084         synchronized (lock) {
085             if (griffonClass == null) {
086                 griffonClass = application.getArtifactManager().findGriffonClass(getClass());
087             }
088             return griffonClass;
089         }
090     }
091 
092     @Nonnull
093     @Override
094     public Logger getLog() {
095         return log;
096     }
097 
098     @Nonnull
099     protected abstract String getArtifactType();
100 
101     @Override
102     public boolean isUIThread() {
103         return application.getUIThreadManager().isUIThread();
104     }
105 
106     @Nonnull
107     @Override
108     public <R> Future<R> runFuture(@Nonnull ExecutorService executorService, @Nonnull Callable<R> callable) {
109         return application.getUIThreadManager().runFuture(executorService, callable);
110     }
111 
112     @Nonnull
113     @Override
114     public <R> Future<R> runFuture(@Nonnull Callable<R> callable) {
115         return application.getUIThreadManager().runFuture(callable);
116     }
117 
118     @Override
119     public void runInsideUISync(@Nonnull Runnable runnable) {
120         application.getUIThreadManager().runInsideUISync(runnable);
121     }
122 
123     @Override
124     public void runOutsideUI(@Nonnull Runnable runnable) {
125         application.getUIThreadManager().runOutsideUI(runnable);
126     }
127 
128     @Override
129     public void runInsideUIAsync(@Nonnull Runnable runnable) {
130         application.getUIThreadManager().runInsideUIAsync(runnable);
131     }
132 
133     @Nonnull
134     @Override
135     public ClassLoader classloader() {
136         return application.getResourceHandler().classloader();
137     }
138 
139     @Nullable
140     @Override
141     public URL getResourceAsURL(@Nonnull String name) {
142         return application.getResourceHandler().getResourceAsURL(name);
143     }
144 
145     @Nullable
146     @Override
147     public List<URL> getResources(@Nonnull String name) {
148         return application.getResourceHandler().getResources(name);
149     }
150 
151     @Nullable
152     @Override
153     public InputStream getResourceAsStream(@Nonnull String name) {
154         return application.getResourceHandler().getResourceAsStream(name);
155     }
156 
157     @Nonnull
158     @Override
159     public MVCGroup createMVCGroup(@Nonnull Map<String, Object> args, @Nonnull String mvcType) {
160         return application.getMvcGroupManager().createMVCGroup(args, mvcType);
161     }
162 
163     @Nonnull
164     @Override
165     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType) {
166         return application.getMvcGroupManager().createMVC(mvcType);
167     }
168 
169     @Override
170     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull MVCFunction<M, V, C> handler) {
171         application.getMvcGroupManager().withMVC(mvcType, mvcId, handler);
172     }
173 
174     @Nonnull
175     @Override
176     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType, @Nonnull String mvcId) {
177         return application.getMvcGroupManager().createMVC(mvcType, mvcId);
178     }
179 
180     @Nonnull
181     @Override
182     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull String mvcId) {
183         return application.getMvcGroupManager().createMVC(args, mvcType, mvcId);
184     }
185 
186     @Override
187     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull String mvcId, @Nonnull MVCFunction<M, V, C> handler) {
188         application.getMvcGroupManager().withMVC(args, mvcType, mvcId, handler);
189     }
190 
191     @Nonnull
192     @Override
193     public MVCGroup createMVCGroup(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull String mvcId) {
194         return application.getMvcGroupManager().createMVCGroup(args, mvcType, mvcId);
195     }
196 
197     @Nonnull
198     @Override
199     public MVCGroup createMVCGroup(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull Map<String, Object> args) {
200         return application.getMvcGroupManager().createMVCGroup(mvcType, mvcId, args);
201     }
202 
203     @Nonnull
204     @Override
205     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull Map<String, Object> args, @Nonnull String mvcType) {
206         return application.getMvcGroupManager().createMVC(args, mvcType);
207     }
208 
209     @Override
210     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull String mvcType, @Nonnull MVCFunction<M, V, C> handler) {
211         application.getMvcGroupManager().withMVC(mvcType, handler);
212     }
213 
214     @Nonnull
215     @Override
216     public MVCGroup createMVCGroup(@Nonnull String mvcType) {
217         return application.getMvcGroupManager().createMVCGroup(mvcType);
218     }
219 
220     @Nonnull
221     @Override
222     public MVCGroup createMVCGroup(@Nonnull String mvcType, @Nonnull String mvcId) {
223         return application.getMvcGroupManager().createMVCGroup(mvcType, mvcId);
224     }
225 
226     @Nonnull
227     @Override
228     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType, @Nonnull Map<String, Object> args) {
229         return application.getMvcGroupManager().createMVC(mvcType, args);
230     }
231 
232     @Override
233     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull MVCFunction<M, V, C> handler) {
234         application.getMvcGroupManager().withMVC(args, mvcType, handler);
235     }
236 
237     @Override
238     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull String mvcType, @Nonnull Map<String, Object> args, @Nonnull MVCFunction<M, V, C> handler) {
239         application.getMvcGroupManager().withMVC(mvcType, args, handler);
240     }
241 
242     @Nonnull
243     @Override
244     public MVCGroup createMVCGroup(@Nonnull String mvcType, @Nonnull Map<String, Object> args) {
245         return application.getMvcGroupManager().createMVCGroup(mvcType, args);
246     }
247 
248     @Nonnull
249     @Override
250     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull Map<String, Object> args) {
251         return application.getMvcGroupManager().createMVC(mvcType, mvcId, args);
252     }
253 
254     @Override
255     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull Map<String, Object> args, @Nonnull MVCFunction<M, V, C> handler) {
256         application.getMvcGroupManager().withMVC(mvcType, mvcId, args, handler);
257     }
258 
259     @Override
260     public void withMVCGroup(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull MVCGroupFunction handler) {
261         application.getMvcGroupManager().withMVCGroup(args, mvcType, handler);
262     }
263 
264     @Override
265     public void withMVCGroup(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull String mvcId, @Nonnull MVCGroupFunction handler) {
266         application.getMvcGroupManager().withMVCGroup(args, mvcType, mvcId, handler);
267     }
268 
269     @Override
270     public void withMVCGroup(@Nonnull String mvcType, @Nonnull Map<String, Object> args, @Nonnull MVCGroupFunction handler) {
271         application.getMvcGroupManager().withMVCGroup(mvcType, args, handler);
272     }
273 
274     @Override
275     public void withMVCGroup(@Nonnull String mvcType, @Nonnull MVCGroupFunction handler) {
276         application.getMvcGroupManager().withMVCGroup(mvcType, handler);
277     }
278 
279     @Override
280     public void withMVCGroup(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull Map<String, Object> args, @Nonnull MVCGroupFunction handler) {
281         application.getMvcGroupManager().withMVCGroup(mvcType, mvcId, args, handler);
282     }
283 
284     @Override
285     public void withMVCGroup(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull MVCGroupFunction handler) {
286         application.getMvcGroupManager().withMVCGroup(mvcType, mvcId, handler);
287     }
288 
289     @Override
290     public void destroyMVCGroup(@Nonnull String mvcId) {
291         application.getMvcGroupManager().destroyMVCGroup(mvcId);
292     }
293 }