Package io.github.angularwave.android.core.ng.nav

Enum Presentation

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable 
    
public enum Presentation
extends Enum<Presentation>

    Represents how a given navigation destination should be presented and how the app's backstack will be affected.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT

      A generic default value when no specific presentation value is provided and results in generally accepted "normal" behavior — replacing the root when on the start destination and going to the start destination again, popping when the location is in the immediate backstack, replacing when going to the same destination, and pushing in all other cases.
      PUSH

      Pushes a new location onto the nav stack.
      POP

      Pops a location off the nav stack.
      REPLACE

      Pops the current location off the nav stack and pushes a new location onto the nav stack.
      CLEAR_ALL

      Clears the entire back stack and retains the start destination for the nav host.
      REPLACE_ROOT

      Clears the entire back stack and replaces the start destination for the nav host.
      REFRESH

      Will force a reload of the current location and clear out any saved visit options.
      NONE

      Will result in no navigation action being taken.

    • Method Summary

      Modifier and Type Method Description
      final Presentation valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<Presentation> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final EnumEntries<Presentation> getEntries() Represents how a given navigation destination should be presented and how the app's backstack will be affected.

      • Methods inherited from class kotlin.Enum

        getName, getOrdinal

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • valueOf

         final Presentation valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

      • values

         final Array<Presentation> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.

      • getEntries

         final EnumEntries<Presentation> getEntries()

        Represents how a given navigation destination should be presented and how the app's backstack will be affected.