Promote SchemaSourceRepresentation
[yangtools.git] / parser / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / repo / SharedSchemaRepository.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.parser.repo;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.annotations.Beta;
13 import com.google.common.cache.CacheBuilder;
14 import com.google.common.cache.CacheLoader;
15 import com.google.common.cache.LoadingCache;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.kohsuke.MetaInfServices;
18 import org.opendaylight.yangtools.concepts.Identifiable;
19 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
20 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
21 import org.opendaylight.yangtools.yang.model.repo.api.EffectiveModelContextFactory;
22 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactoryConfiguration;
23 import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
24 import org.opendaylight.yangtools.yang.model.repo.spi.AbstractSchemaRepository;
25 import org.opendaylight.yangtools.yang.parser.api.YangParserFactory;
26 import org.opendaylight.yangtools.yang.parser.impl.DefaultYangParserFactory;
27
28 /**
29  * A {@link SchemaRepository} which allows sharing of {@link SchemaContext} as long as their specification is the same.
30  *
31  * <p>
32  * Note: for current implementation, "same" means the same filter and the same set of {@link SourceIdentifier}s.
33  */
34 @Beta
35 @MetaInfServices(value = SchemaRepository.class)
36 public final class SharedSchemaRepository extends AbstractSchemaRepository implements Identifiable<String> {
37     private final LoadingCache<SchemaContextFactoryConfiguration, EffectiveModelContextFactory> cacheByConfig =
38             CacheBuilder.newBuilder().softValues()
39             .build(new CacheLoader<SchemaContextFactoryConfiguration, EffectiveModelContextFactory>() {
40                 @Override
41                 public EffectiveModelContextFactory load(final SchemaContextFactoryConfiguration key) {
42                     return new SharedEffectiveModelContextFactory(SharedSchemaRepository.this, key);
43                 }
44             });
45
46     private final @NonNull String id;
47     private final @NonNull YangParserFactory factory;
48
49     public SharedSchemaRepository() {
50         this("unnamed");
51     }
52
53     public SharedSchemaRepository(final String id) {
54         this(id, new DefaultYangParserFactory());
55     }
56
57     public SharedSchemaRepository(final String id, final YangParserFactory factory) {
58         this.id = requireNonNull(id);
59         this.factory = requireNonNull(factory);
60     }
61
62     @Override
63     public @NonNull String getIdentifier() {
64         return id;
65     }
66
67     @Override
68     public @NonNull EffectiveModelContextFactory createEffectiveModelContextFactory(
69             final @NonNull SchemaContextFactoryConfiguration config) {
70         return cacheByConfig.getUnchecked(config);
71     }
72
73     @NonNull YangParserFactory factory() {
74         return factory;
75     }
76
77     @Override
78     public String toString() {
79         return "SchemaRepository: " + id;
80     }
81 }