1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.collections4;
18
19 import org.apache.commons.collections4.trie.UnmodifiableTrie;
20
21 /**
22 * A collection of {@link Trie} utilities.
23 *
24 * @since 4.0
25 */
26 public class TrieUtils {
27
28 /**
29 * Returns an unmodifiable instance of a {@link Trie}
30 *
31 * @param <K> the key type
32 * @param <V> the value type
33 * @param trie the trie to make unmodifiable, must not be null
34 * @return an unmodifiable trie backed by the given trie
35 * @throws NullPointerException if trie is null
36 * @see java.util.Collections#unmodifiableMap(java.util.Map)
37 */
38 public static <K, V> Trie<K, V> unmodifiableTrie(final Trie<K, ? extends V> trie) {
39 return UnmodifiableTrie.unmodifiableTrie(trie);
40 }
41
42 /**
43 * Don't allow instances.
44 */
45 private TrieUtils() {
46 // empty
47 }
48
49 }