2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.repo.util;
10 import com.google.common.base.Preconditions;
12 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
13 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
14 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
15 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource.Costs;
16 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceListener;
17 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
18 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
19 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
22 * Abstract base class for cache-type SchemaSourceListeners. It needs to be
23 * registered with a {@link SchemaSourceRegistry}, where it gets notifications
24 * from. It performs filtering and {@link #offer(SchemaSourceRepresentation)}s
25 * conforming sources to the subclass.
27 * @param <T> Cached schema source type.
29 public abstract class AbstractSchemaSourceCache<T extends SchemaSourceRepresentation> implements SchemaSourceListener, SchemaSourceProvider<T> {
30 private final SchemaSourceRegistry consumer;
31 private final Class<T> representation;
32 private final Costs cost;
34 protected AbstractSchemaSourceCache(final SchemaSourceRegistry consumer, final Class<T> representation, final Costs cost) {
35 this.consumer = Preconditions.checkNotNull(consumer);
36 this.representation = Preconditions.checkNotNull(representation);
37 this.cost = Preconditions.checkNotNull(cost);
41 * Offer a schema source in requested representation for caching. Subclasses
42 * need to implement this method to store the schema source. Once they have
43 * determined to cache the source, they should call {@link #register(SourceIdentifier)}.
45 * @param source schema source
47 protected abstract void offer(T source);
50 * Register the presence of a cached schema source with the consumer. Subclasses
51 * need to call this method once they have cached a schema source representation,
52 * or when they have determined they have a schema source is available -- like
53 * when a persistent cache reads its cache index.
55 * @param sourceIdentifier Source identifier
56 * @return schema source registration, which the subclass needs to
57 * {@link SchemaSourceRegistration#close()} once it expunges the source
60 protected final SchemaSourceRegistration<T> register(final SourceIdentifier sourceIdentifier) {
61 final PotentialSchemaSource<T> src = PotentialSchemaSource.create(sourceIdentifier, representation, cost.getValue());
62 return consumer.registerSchemaSource(this, src);
66 public void schemaSourceEncountered(final SchemaSourceRepresentation source) {
67 if (representation.isAssignableFrom(source.getType())) {
68 @SuppressWarnings("unchecked")
69 final T src = (T)source;
75 public final void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> sources) {
80 public final void schemaSourceUnregistered(final PotentialSchemaSource<?> source) {