GriffonMvcArtifact.java
01 /*
02  * SPDX-License-Identifier: Apache-2.0
03  *
04  * Copyright 2008-2017 the original author or authors.
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 package griffon.core.artifact;
19 
20 import griffon.core.mvc.MVCGroup;
21 
22 import javax.annotation.Nonnull;
23 import java.util.Map;
24 
25 /**
26  * Identifies an artifact that belongs to an MVC group.<p>
27  *
28  @author Andres Almiray
29  @since 2.0.0
30  */
31 public interface GriffonMvcArtifact extends GriffonArtifact {
32     /**
33      * Post initialization callback.<p>
34      * This callback is called for all artifacts that belong to the
35      * same MVC group right after each instance has been created.
36      * Each entry on the <tt>args</tt> Map points either to an MVC
37      * member or a variable that was defined using any of the {@code createMVCGroup}
38      * and/or {@code createMVC} methods that can take a Map as parameter.
39      *
40      @param args a Map of MVC instances or variables keyed by type.
41      */
42     void mvcGroupInit(@Nonnull Map<String, Object> args);
43 
44     /**
45      * Callback for when the group is destroyed and disposed from the application.<p>
46      * Once an artifact has been "destroyed" it should not be used anymore. The application
47      * will remove any references to the group on its cache.
48      */
49     void mvcGroupDestroy();
50 
51     @Nonnull
52     MVCGroup getMvcGroup();
53 }