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