Source for gnu.javax.crypto.assembly.Direction

   1: /* Direction.java --
   2:    Copyright (C) 2003, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is a part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2 of the License, or (at
   9: your option) any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: USA
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version.  */
  37: 
  38: 
  39: package gnu.javax.crypto.assembly;
  40: 
  41: /**
  42:  * An enumeration type for wiring {@link Stage} instances into {@link Cascade}
  43:  * Cipher chains, as well as for operating a {@link Cascade} in a given
  44:  * direction.
  45:  * <p>
  46:  * The possible values for this type are two:
  47:  * <ol>
  48:  * <li>FORWARD: equivalent to {@link gnu.javax.crypto.mode.IMode#ENCRYPTION},
  49:  * and its inverse value</li>
  50:  * <li>REVERSED: equivalent to {@link gnu.javax.crypto.mode.IMode#DECRYPTION}.
  51:  * </li>
  52:  * </ol>
  53:  */
  54: public final class Direction
  55: {
  56:   public static final Direction FORWARD = new Direction(1);
  57: 
  58:   public static final Direction REVERSED = new Direction(2);
  59: 
  60:   private int value;
  61: 
  62:   private Direction(int value)
  63:   {
  64:     super();
  65: 
  66:     this.value = value;
  67:   }
  68: 
  69:   public static final Direction reverse(Direction d)
  70:   {
  71:     return (d.equals(FORWARD) ? REVERSED : FORWARD);
  72:   }
  73: 
  74:   public String toString()
  75:   {
  76:     return (this == FORWARD ? "forward" : "reversed");
  77:   }
  78: }