NoModuleException.java

/**
 * The FreeBSD Copyright
 * Copyright 1994-2008 The FreeBSD Project. All rights reserved.
 * Copyright (C) 2013-2017 Philip Helger philip[at]helger[dot]com
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *    1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE FREEBSD PROJECT ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FREEBSD PROJECT OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation
 * are those of the authors and should not be interpreted as representing
 * official policies, either expressed or implied, of the FreeBSD Project.
 */
package com.helger.as2lib.processor;

import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.as2lib.exception.OpenAS2Exception;
import com.helger.as2lib.message.IMessage;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.ext.CommonsHashMap;
import com.helger.commons.collection.ext.ICommonsMap;

public class NoModuleException extends OpenAS2Exception
{
  private final ICommonsMap <String, Object> m_aOptions;
  private final IMessage m_aMsg;
  private final String m_sAction;

  public NoModuleException (@Nullable final String sAction,
                            @Nullable final IMessage aMsg,
                            @Nullable final Map <String, Object> aOptions)
  {
    super (getAsString (sAction, aMsg, aOptions));
    m_sAction = sAction;
    m_aMsg = aMsg;
    m_aOptions = new CommonsHashMap <> (aOptions);
  }

  @Nullable
  public String getAction ()
  {
    return m_sAction;
  }

  @Nullable
  public IMessage getMsg ()
  {
    return m_aMsg;
  }

  @Nullable
  @ReturnsMutableObject ("design")
  public ICommonsMap <String, Object> getOptions ()
  {
    return m_aOptions;
  }

  @Nonnull
  public String getAsString ()
  {
    return getAsString (getAction (), getMsg (), getOptions ());
  }

  @Nonnull
  @Nonempty
  protected static String getAsString (@Nullable final String sAction,
                                       @Nullable final IMessage aMsg,
                                       @Nullable final Map <String, Object> aOptions)
  {
    return "NoModuleException: Requested action: " + sAction + "; Message: " + aMsg + "; Options: " + aOptions;
  }
}