AbstractGriffonArtifactScript.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.groovy.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 groovy.lang.Script;
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  @author Andres Almiray
045  */
046 public abstract class AbstractGriffonArtifactScript extends Script implements GriffonArtifact {
047     private final Logger log;
048     @Inject
049     protected GriffonApplication application;
050     @GuardedBy("lock")
051     private GriffonClass griffonClass;
052     private final Object lock = new Object[0];
053 
054     public AbstractGriffonArtifactScript() {
055         log = LoggerFactory.getLogger("griffon.app." + getArtifactType() "." + getClass().getName());
056     }
057 
058     @Nonnull
059     public GriffonApplication getApplication() {
060         return application;
061     }
062 
063     @Nonnull
064     @Override
065     public GriffonClass getGriffonClass() {
066         synchronized (lock) {
067             if (griffonClass == null) {
068                 griffonClass = application.getArtifactManager().findGriffonClass(getClass());
069             }
070             //noinspection ConstantConditions
071             return griffonClass;
072         }
073     }
074 
075     @Nonnull
076     @Override
077     public Logger getLog() {
078         return log;
079     }
080 
081     @Nonnull
082     protected abstract String getArtifactType();
083 
084     public boolean isUIThread() {
085         return application.getUIThreadManager().isUIThread();
086     }
087 
088     @Nonnull
089     public <R> Future<R> runFuture(@Nonnull ExecutorService executorService, @Nonnull Callable<R> callable) {
090         return application.getUIThreadManager().runFuture(executorService, callable);
091     }
092 
093     @Nonnull
094     public <R> Future<R> runFuture(@Nonnull Callable<R> callable) {
095         return application.getUIThreadManager().runFuture(callable);
096     }
097 
098     public void runInsideUISync(@Nonnull Runnable runnable) {
099         application.getUIThreadManager().runInsideUISync(runnable);
100     }
101 
102     public void runOutsideUI(@Nonnull Runnable runnable) {
103         application.getUIThreadManager().runOutsideUI(runnable);
104     }
105 
106     public void runInsideUIAsync(@Nonnull Runnable runnable) {
107         application.getUIThreadManager().runInsideUIAsync(runnable);
108     }
109 
110     @Nonnull
111     public ClassLoader classloader() {
112         return application.getResourceHandler().classloader();
113     }
114 
115     @Nullable
116     public URL getResourceAsURL(@Nonnull String name) {
117         return application.getResourceHandler().getResourceAsURL(name);
118     }
119 
120     @Nullable
121     public List<URL> getResources(@Nonnull String name) {
122         return application.getResourceHandler().getResources(name);
123     }
124 
125     @Nullable
126     public InputStream getResourceAsStream(@Nonnull String name) {
127         return application.getResourceHandler().getResourceAsStream(name);
128     }
129 
130     @Nonnull
131     public MVCGroup createMVCGroup(@Nonnull Map<String, Object> args, @Nonnull String mvcType) {
132         return application.getMvcGroupManager().createMVCGroup(args, mvcType);
133     }
134 
135     @Nonnull
136     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType) {
137         return application.getMvcGroupManager().createMVC(mvcType);
138     }
139 
140     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull MVCFunction<M, V, C> handler) {
141         application.getMvcGroupManager().withMVC(mvcType, mvcId, handler);
142     }
143 
144     @Nonnull
145     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType, @Nonnull String mvcId) {
146         return application.getMvcGroupManager().createMVC(mvcType, mvcId);
147     }
148 
149     @Nonnull
150     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull String mvcId) {
151         return application.getMvcGroupManager().createMVC(args, mvcType, mvcId);
152     }
153 
154     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) {
155         application.getMvcGroupManager().withMVC(args, mvcType, mvcId, handler);
156     }
157 
158     @Nonnull
159     public MVCGroup createMVCGroup(@Nonnull Map<String, Object> args, @Nonnull String mvcType, @Nonnull String mvcId) {
160         return application.getMvcGroupManager().createMVCGroup(args, mvcType, mvcId);
161     }
162 
163     @Nonnull
164     public MVCGroup createMVCGroup(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull Map<String, Object> args) {
165         return application.getMvcGroupManager().createMVCGroup(mvcType, mvcId, args);
166     }
167 
168     @Nonnull
169     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull Map<String, Object> args, @Nonnull String mvcType) {
170         return application.getMvcGroupManager().createMVC(args, mvcType);
171     }
172 
173     public <M extends GriffonModel, V extends GriffonView, C extends GriffonController> void withMVC(@Nonnull String mvcType, @Nonnull MVCFunction<M, V, C> handler) {
174         application.getMvcGroupManager().withMVC(mvcType, handler);
175     }
176 
177     @Nonnull
178     public MVCGroup createMVCGroup(@Nonnull String mvcType) {
179         return application.getMvcGroupManager().createMVCGroup(mvcType);
180     }
181 
182     @Nonnull
183     public MVCGroup createMVCGroup(@Nonnull String mvcType, @Nonnull String mvcId) {
184         return application.getMvcGroupManager().createMVCGroup(mvcType, mvcId);
185     }
186 
187     @Nonnull
188     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType, @Nonnull Map<String, Object> args) {
189         return application.getMvcGroupManager().createMVC(mvcType, args);
190     }
191 
192     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) {
193         application.getMvcGroupManager().withMVC(args, mvcType, handler);
194     }
195 
196     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) {
197         application.getMvcGroupManager().withMVC(mvcType, args, handler);
198     }
199 
200     @Nonnull
201     public MVCGroup createMVCGroup(@Nonnull String mvcType, @Nonnull Map<String, Object> args) {
202         return application.getMvcGroupManager().createMVCGroup(mvcType, args);
203     }
204 
205     @Nonnull
206     public List<? extends GriffonMvcArtifact> createMVC(@Nonnull String mvcType, @Nonnull String mvcId, @Nonnull Map<String, Object> args) {
207         return application.getMvcGroupManager().createMVC(mvcType, mvcId, args);
208     }
209 
210     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) {
211         application.getMvcGroupManager().withMVC(mvcType, mvcId, args, handler);
212     }
213 
214     public void destroyMVCGroup(@Nonnull String mvcId) {
215         application.getMvcGroupManager().destroyMVCGroup(mvcId);
216     }
217 }