data/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractModuleStringInstanceIdentifierCodec.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.yang.data.util;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.annotations.Beta;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.Module;
  17
  18 /**
  19  * Extension of {@link AbstractStringInstanceIdentifierCodec}, which instantiates
  20  * QNames by first resolving the namespace and then looking the target namespace
  21  * in the list of currently-subscribed modules.
  22  */
  23 @Beta
  24 public abstract class AbstractModuleStringInstanceIdentifierCodec extends AbstractStringInstanceIdentifierCodec {
  25     /**
  26      * Resolve a string prefix into the corresponding module.
  27      *
  28      * @param prefix Prefix
  29      * @return module mapped to prefix, or null if the module cannot be resolved
  30      */
  31     protected abstract @Nullable Module moduleForPrefix(@NonNull String prefix);
  32
  33     @Override
  34     protected final QName createQName(final String prefix, final String localName) {
  35         final Module module = moduleForPrefix(prefix);
  36         checkArgument(module != null, "Failed to lookup prefix %s", prefix);
  37         return QName.create(module.getQNameModule(), localName);
  38     }
  39 }