NoOpState.java

  1. /**
  2.  *
  3.  * Copyright 2018-2020 Florian Schmaus
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.jivesoftware.smack.fsm;

  18. import org.jivesoftware.smack.c2s.ModularXmppClientToServerConnection;
  19. import org.jivesoftware.smack.c2s.internal.ModularXmppClientToServerConnectionInternal;
  20. import org.jivesoftware.smack.c2s.internal.WalkStateGraphContext;

  21. public class NoOpState extends State {

  22.     /**
  23.      * Constructs a NoOpState. Note that the signature of this constructor is designed so that it mimics States which
  24.      * are non-static inner classes of ModularXmppClientToServerConnection. That is why the first argument is not used.
  25.      *
  26.      * @param connection the connection.
  27.      * @param stateDescriptor the related state descriptor
  28.      * @param connectionInternal the internal connection API.
  29.      */
  30.     @SuppressWarnings("UnusedVariable")
  31.     protected NoOpState(ModularXmppClientToServerConnection connection, StateDescriptor stateDescriptor, ModularXmppClientToServerConnectionInternal connectionInternal) {
  32.         super(stateDescriptor, connectionInternal);
  33.     }

  34.     @Override
  35.     public StateTransitionResult.Success transitionInto(WalkStateGraphContext walkStateGraphContext) {
  36.         // Transition into a NoOpState always succeeds.
  37.         return StateTransitionResult.Success.EMPTY_INSTANCE;
  38.     }
  39. }