org.cacheonix.impl.util.logging.Priority Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cacheonix-core Show documentation
Cacheonix is an open source distributed cache for Java that allows its users to scale Java applications in a cluster while preserving the simplicity of design and coding in a single Java VM.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// Contributors:  Kitching Simon 

package org.cacheonix.impl.util.logging;

/**
 * Refrain from using this class directly, use the {@link Level} class instead.
 *
 * @author Ceki Gülcü
 */
@SuppressWarnings("deprecation")
public class Priority {

   transient int level;
   transient String levelStr;
   transient int syslogEquivalent;

   public static final int OFF_INT = Integer.MAX_VALUE;
   public static final int FATAL_INT = 50000;
   public static final int ERROR_INT = 40000;
   public static final int WARN_INT = 30000;
   public static final int INFO_INT = 20000;
   public static final int DEBUG_INT = 10000;
   //public final static int FINE_INT = DEBUG_INT;
   public static final int ALL_INT = Integer.MIN_VALUE;

   /**
    * @deprecated Use {@link Level#FATAL} instead.
    */
   public static final Priority FATAL = new Level(FATAL_INT, "FATAL", 0);

   /**
    * @deprecated Use {@link Level#ERROR} instead.
    */
   public static final Priority ERROR = new Level(ERROR_INT, "ERROR", 3);

   /**
    * @deprecated Use {@link Level#WARN} instead.
    */
   public static final Priority WARN = new Level(WARN_INT, "WARN", 4);

   /**
    * @deprecated Use {@link Level#INFO} instead.
    */
   public static final Priority INFO = new Level(INFO_INT, "INFO", 6);

   /**
    * @deprecated Use {@link Level#DEBUG} instead.
    */
   public static final Priority DEBUG = new Level(DEBUG_INT, "DEBUG", 7);


   /**
    * Default constructor for deserialization.
    */
   protected Priority() {
      level = DEBUG_INT;
      levelStr = "DEBUG";
      syslogEquivalent = 7;
   }


   /**
    * Instantiate a level object.
    */
   protected Priority(final int level, final String levelStr, final int syslogEquivalent) {
      this.level = level;
      this.levelStr = levelStr;
      this.syslogEquivalent = syslogEquivalent;
   }


   /**
    * Two priorities are equal if their level fields are equal.
    *
    * @since 1.2
    */
   public final boolean equals(final Object o) {
      if (o instanceof Priority) {
         final Priority r = (Priority) o;
         return this.level == r.level;
      } else {
         return false;
      }
   }


   public final int hashCode() {
      return level;
   }


   /**
    * Return the syslog equivalent of this priority as an integer.
    */
   public
   final int getSyslogEquivalent() {
      return syslogEquivalent;
   }


   /**
    * Returns true if this level has a higher or equal level than the level passed as argument,
    * false otherwise.
    * 
    * You should think twice before overriding the default implementation of isGreaterOrEqual method.
    */
   public final boolean isGreaterOrEqual(final Priority r) {
      return level >= r.level;
   }


   /**
    * Return all possible priorities as an array of Level objects in descending order.
    *
    * @deprecated This method will be removed with no replacement.
    */
   public
   static Priority[] getAllPossiblePriorities() {
      return new Priority[]{FATAL, ERROR, Level.WARN,
              INFO, DEBUG};
   }


   /**
    * Returns the string representation of this priority.
    */
   public final String toString() {
      return levelStr;
   }


   /**
    * Returns the integer representation of this level.
    */
   public
   final int toInt() {
      return level;
   }


   /**
    * @deprecated Please use the {@link Level#toLevel(String)} method instead.
    */
   public
   static Priority toPriority(final String sArg) {
      return Level.toLevel(sArg);
   }


   /**
    * @deprecated Please use the {@link Level#toLevel(int)} method instead.
    */
   public
   static Priority toPriority(final int val) {
      return toPriority(val, DEBUG);
   }


   /**
    * @deprecated Please use the {@link Level#toLevel(int, Level)} method instead.
    */
   public
   static Priority toPriority(final int val, final Priority defaultPriority) {
      return Level.toLevel(val, (Level) defaultPriority);
   }


   /**
    * @deprecated Please use the {@link Level#toLevel(String, Level)} method instead.
    */
   public
   static Priority toPriority(final String sArg, final Priority defaultPriority) {
      return Level.toLevel(sArg, (Level) defaultPriority);
   }
}