common/util/src/main/java/org/opendaylight/yangtools/util/Immutables.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.util;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.collect.ImmutableSet;
  13 import java.math.BigDecimal;
  14 import java.math.BigInteger;
  15 import org.opendaylight.yangtools.concepts.Immutable;
  16 import org.opendaylight.yangtools.concepts.Mutable;
  17
  18 public final class Immutables {
  19     private static final ImmutableSet<Class<?>> KNOWN_IMMUTABLES = ImmutableSet.of(
  20             Integer.class, Short.class, BigDecimal.class, BigInteger.class, Byte.class, Character.class, Double.class,
  21             Float.class, String.class, Boolean.class, Void.class);
  22
  23     private Immutables() {
  24         // Hidden on purpose
  25     }
  26
  27     /**
  28      * Determines if object is known to be immutable
  29      *
  30      * <p>Note: This method may return false to immutable objects which
  31      * immutability is not known, was defined not using concepts term.
  32      *
  33      * @param obj
  34      *            Reference to check
  35      * @return true if object is known to be immutable false otherwise.
  36      */
  37     public static boolean isImmutable(final Object obj) {
  38         checkArgument(obj != null,"Object should not be null");
  39         if (obj instanceof Mutable) {
  40             return false;
  41         } else if (obj instanceof Immutable) {
  42             return true;
  43         } else if (obj instanceof String) {
  44             return true;
  45         } else if (KNOWN_IMMUTABLES.contains(obj.getClass())) {
  46             return true;
  47         }
  48         return false;
  49     }
  50 }