PivotActionManager.java
001 /*
002  * SPDX-License-Identifier: Apache-2.0
003  *
004  * Copyright 2008-2017 the original author or authors.
005  *
006  * Licensed under the Apache License, Version 2.0 (the "License");
007  * you may not use this file except in compliance with the License.
008  * You may obtain a copy of the License at
009  *
010  *     http://www.apache.org/licenses/LICENSE-2.0
011  *
012  * Unless required by applicable law or agreed to in writing, software
013  * distributed under the License is distributed on an "AS IS" BASIS,
014  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015  * See the License for the specific language governing permissions and
016  * limitations under the License.
017  */
018 package org.codehaus.griffon.runtime.pivot.controller;
019 
020 import griffon.core.GriffonApplication;
021 import griffon.core.artifact.GriffonController;
022 import griffon.core.controller.Action;
023 import griffon.core.controller.ActionFactory;
024 import griffon.core.controller.ActionMetadataFactory;
025 import griffon.exceptions.InstanceMethodInvocationException;
026 import org.apache.pivot.wtk.Component;
027 import org.codehaus.griffon.runtime.core.controller.AbstractActionManager;
028 import org.slf4j.Logger;
029 import org.slf4j.LoggerFactory;
030 
031 import javax.annotation.Nonnull;
032 import javax.annotation.Nullable;
033 import javax.inject.Inject;
034 import java.beans.PropertyChangeEvent;
035 import java.beans.PropertyChangeListener;
036 
037 import static griffon.util.GriffonClassUtils.EMPTY_ARGS;
038 import static griffon.util.GriffonClassUtils.invokeExactInstanceMethod;
039 import static griffon.util.GriffonNameUtils.getNaturalName;
040 import static griffon.util.GriffonNameUtils.isNotBlank;
041 import static griffon.util.TypeUtils.castToBoolean;
042 
043 /**
044  @author Andres Almiray
045  @since 2.0.0
046  */
047 public class PivotActionManager extends AbstractActionManager {
048     private static final Logger LOG = LoggerFactory.getLogger(PivotActionManager.class);
049 
050     private static final String EMPTY_STRING = "";
051     private static final String DOT = ".";
052     private static final String EQUALS = " = ";
053     private static final String KEY_NAME = "name";
054     private static final String KEY_DESCRIPTION = "description";
055     private static final String KEY_ENABLED = "enabled";
056 
057     @Inject
058     public PivotActionManager(@Nonnull GriffonApplication application, @Nonnull ActionFactory actionFactory, @Nonnull ActionMetadataFactory actionMetadataFactory) {
059         super(application, actionFactory, actionMetadataFactory);
060     }
061 
062     @Override
063     protected void doConfigureAction(@Nonnull final Action action, @Nonnull final GriffonController controller, @Nonnull final String normalizeNamed, @Nonnull final String keyPrefix) {
064         controller.getApplication().addPropertyChangeListener(GriffonApplication.PROPERTY_LOCALE, new PropertyChangeListener() {
065             @Override
066             public void propertyChange(PropertyChangeEvent evt) {
067                 configureAction((PivotGriffonControllerActionaction, controller, normalizeNamed, keyPrefix);
068             }
069         });
070         configureAction((PivotGriffonControllerActionaction, controller, normalizeNamed, keyPrefix);
071     }
072 
073     protected void configureAction(@Nonnull PivotGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
074         resolveName(action, controller, normalizeNamed, keyPrefix);
075         resolveDescription(action, controller, normalizeNamed, keyPrefix);
076         resolveEnabled(action, controller, normalizeNamed, keyPrefix);
077     }
078 
079     protected void resolveName(@Nonnull PivotGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
080         String rsActionName = msg(keyPrefix, normalizeNamed, KEY_NAME, getNaturalName(normalizeNamed));
081         if (isNotBlank(rsActionName)) {
082             trace(keyPrefix + normalizeNamed, KEY_NAME, rsActionName);
083             action.setName(rsActionName);
084         }
085     }
086 
087     protected void resolveDescription(@Nonnull PivotGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
088         String rsDescription = msg(keyPrefix, normalizeNamed, KEY_DESCRIPTION, EMPTY_STRING);
089         if (isNotBlank(rsDescription)) {
090             trace(keyPrefix + normalizeNamed, KEY_DESCRIPTION, rsDescription);
091             action.setDescription(rsDescription);
092         }
093     }
094 
095     protected void resolveEnabled(@Nonnull PivotGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
096         String rsEnabled = msg(keyPrefix, normalizeNamed, KEY_ENABLED, "true");
097         if (isNotBlank(rsEnabled)) {
098             trace(keyPrefix + normalizeNamed, KEY_ENABLED, rsEnabled);
099             action.setEnabled(castToBoolean(rsEnabled));
100         }
101     }
102 
103     @Nullable
104     @Override
105     protected Object doInvokeAction(@Nonnull GriffonController controller, @Nonnull String actionName, @Nonnull Object[] updatedArgs) {
106         try {
107             return invokeExactInstanceMethod(controller, actionName, updatedArgs);
108         catch (InstanceMethodInvocationException imie) {
109             if (imie.getCause() instanceof NoSuchMethodException) {
110                 // try again but this time remove the 1st arg if it's
111                 // descendant of org.apache.pivot.wtk.Component
112                 if (updatedArgs.length == && updatedArgs[0!= null && Component.class.isAssignableFrom(updatedArgs[0].getClass())) {
113                     return invokeExactInstanceMethod(controller, actionName, EMPTY_ARGS);
114                 else {
115                     throw imie;
116                 }
117             else {
118                 throw imie;
119             }
120         }
121     }
122 
123     protected void trace(@Nonnull String actionKey, @Nonnull String key, @Nonnull String value) {
124         if (LOG.isTraceEnabled()) {
125             LOG.trace(actionKey + DOT + key + EQUALS + value);
126         }
127     }
128 }