001package jmri.jmrit.logixng.implementation;
002
003import java.util.ArrayList;
004import java.util.List;
005import java.util.Map;
006import java.util.HashMap;
007import java.util.ServiceLoader;
008
009import javax.annotation.Nonnull;
010
011import jmri.*;
012import jmri.jmrit.logixng.*;
013import jmri.util.*;
014
015/**
016 * Class providing the basic logic of the ActionManager interface.
017 *
018 * @author Dave Duchamp       Copyright (C) 2007
019 * @author Daniel Bergqvist   Copyright (C) 2018
020 */
021public class DefaultStringActionManager extends AbstractBaseManager<MaleStringActionSocket>
022        implements StringActionManager {
023
024    private final Map<Category, List<Class<? extends Base>>> actionClassList = new HashMap<>();
025    private MaleSocket _lastRegisteredBean;
026
027
028    public DefaultStringActionManager() {
029        InstanceManager.getDefault(LogixNG_Manager.class).registerManager(this);
030
031        for (StringActionFactory actionFactory : ServiceLoader.load(StringActionFactory.class)) {
032            actionFactory.init();
033        }
034
035        for (Category category : Category.values()) {
036            actionClassList.put(category, new ArrayList<>());
037        }
038
039        for (StringActionFactory actionFactory : ServiceLoader.load(StringActionFactory.class)) {
040            actionFactory.getClasses().forEach((entry) -> {
041//                System.out.format("Add action: %s, %s%n", entry.getKey().name(), entry.getValue().getName());
042                actionClassList.get(entry.getKey()).add(entry.getValue());
043            });
044        }
045
046        for (MaleStringActionSocketFactory maleSocketFactory : ServiceLoader.load(MaleStringActionSocketFactory.class)) {
047            _maleSocketFactories.add(maleSocketFactory);
048        }
049    }
050
051    /** {@inheritDoc} */
052    @Override
053    public Class<? extends MaleSocket> getMaleSocketClass() {
054        return DefaultMaleStringActionSocket.class;
055    }
056
057    protected MaleStringActionSocket createMaleActionSocket(StringActionBean action) {
058        MaleStringActionSocket socket = new DefaultMaleStringActionSocket(this, action);
059        action.setParent(socket);
060        return socket;
061    }
062
063    /** {@inheritDoc} */
064    @Override
065    public MaleSocket getLastRegisteredMaleSocket() {
066        return _lastRegisteredBean;
067    }
068
069    /** {@inheritDoc} */
070    @Override
071    public MaleStringActionSocket registerBean(MaleStringActionSocket maleSocket) {
072        MaleStringActionSocket bean = super.registerBean(maleSocket);
073        _lastRegisteredBean = maleSocket;
074        return bean;
075    }
076
077    /**
078     * Remember a NamedBean Object created outside the manager.
079     * This method creates a MaleActionSocket for the action.
080     *
081     * @param action the bean
082     */
083    @Override
084    public MaleStringActionSocket registerAction(@Nonnull StringActionBean action)
085            throws IllegalArgumentException {
086
087        if (action instanceof MaleStringActionSocket) {
088            throw new IllegalArgumentException("registerAction() cannot register a MaleStringActionSocket. Use the method register() instead.");
089        }
090
091        // Check if system name is valid
092        if (this.validSystemNameFormat(action.getSystemName()) != NameValidity.VALID) {
093            log.warn("SystemName {} is not in the correct format", action.getSystemName() );
094            throw new IllegalArgumentException(String.format("System name is invalid: %s", action.getSystemName()));
095        }
096
097        // Keep track of the last created auto system name
098        updateAutoNumber(action.getSystemName());
099
100        MaleStringActionSocket maleSocket = createMaleActionSocket(action);
101        return registerBean(maleSocket);
102    }
103
104    @Override
105    public int getXMLOrder() {
106        return LOGIXNG_STRING_ACTIONS;
107    }
108
109    @Override
110    public char typeLetter() {
111        return 'Q';
112    }
113
114    /*.*
115     * Test if parameter is a properly formatted system name.
116     *
117     * @param systemName the system name
118     * @return enum indicating current validity, which might be just as a prefix
119     *./
120    @Override
121    public NameValidity validSystemNameFormat(String systemName) {
122        return LogixNG_Manager.validSystemNameFormat(
123                getSubSystemNamePrefix(), systemName);
124    }
125*/
126    @Override
127    public FemaleStringActionSocket createFemaleSocket(
128            Base parent, FemaleSocketListener listener, String socketName) {
129        return new DefaultFemaleStringActionSocket(parent, listener, socketName);
130    }
131
132    @Override
133    public Map<Category, List<Class<? extends Base>>> getActionClasses() {
134        return actionClassList;
135    }
136
137    /** {@inheritDoc} */
138    @Override
139    public String getBeanTypeHandled(boolean plural) {
140        return Bundle.getMessage(plural ? "BeanNameStringActions" : "BeanNameStringAction");
141    }
142
143    /** {@inheritDoc} */
144    @Override
145    public void deleteStringAction(MaleStringActionSocket x) {
146        // delete the StringAction
147        deregister(x);
148        x.dispose();
149    }
150
151    static volatile DefaultStringActionManager _instance = null;
152
153    @InvokeOnGuiThread  // this method is not thread safe
154    static public DefaultStringActionManager instance() {
155        if (!ThreadingUtil.isGUIThread()) {
156            LoggingUtil.warnOnce(log, "instance() called on wrong thread");
157        }
158
159        if (_instance == null) {
160            _instance = new DefaultStringActionManager();
161        }
162        return (_instance);
163    }
164
165    @Override
166    public Class<MaleStringActionSocket> getNamedBeanClass() {
167        return MaleStringActionSocket.class;
168    }
169
170    @Override
171    protected MaleStringActionSocket castBean(MaleSocket maleSocket) {
172        return (MaleStringActionSocket)maleSocket;
173    }
174
175
176    private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(DefaultStringActionManager.class);
177
178}