f11a35af32
Motivation: DomainMappingBuilder should have been named as DomainNameMappingBuilder because it builds a DomainNameMapping. Modifications: - Add DomainNameMappingBuilder that does the same job with DomainMappingBuilder - Deprecate DomainMappingBuilder and delegate its logic to DomainNameMappingBuilder - Remove the references to the deprecated methods and classes related with domain name mapping - Miscellaneous: - Fix Javadoc of DomainNameMapping.asMap() - Pre-create the unmodifiable map in DomainNameMapping Result: - Consistent naming - Less use of deprecated API
78 lines
2.9 KiB
Java
78 lines
2.9 KiB
Java
/*
|
|
* Copyright 2015 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
|
|
package io.netty.util;
|
|
|
|
/**
|
|
* Builder for immutable {@link DomainNameMapping} instances.
|
|
*
|
|
* @param <V> concrete type of value objects
|
|
* @deprecated Use {@link DomainNameMappingBuilder} instead.
|
|
*/
|
|
@Deprecated
|
|
public final class DomainMappingBuilder<V> {
|
|
|
|
private final DomainNameMappingBuilder<V> builder;
|
|
|
|
/**
|
|
* Constructor with default initial capacity of the map holding the mappings
|
|
*
|
|
* @param defaultValue the default value for {@link DomainNameMapping#map(String)} to return
|
|
* when nothing matches the input
|
|
*/
|
|
public DomainMappingBuilder(V defaultValue) {
|
|
builder = new DomainNameMappingBuilder<V>(defaultValue);
|
|
}
|
|
|
|
/**
|
|
* Constructor with initial capacity of the map holding the mappings
|
|
*
|
|
* @param initialCapacity initial capacity for the internal map
|
|
* @param defaultValue the default value for {@link DomainNameMapping#map(String)} to return
|
|
* when nothing matches the input
|
|
*/
|
|
public DomainMappingBuilder(int initialCapacity, V defaultValue) {
|
|
builder = new DomainNameMappingBuilder<V>(initialCapacity, defaultValue);
|
|
}
|
|
|
|
/**
|
|
* Adds a mapping that maps the specified (optionally wildcard) host name to the specified output value.
|
|
* Null values are forbidden for both hostnames and values.
|
|
* <p>
|
|
* <a href="http://en.wikipedia.org/wiki/Wildcard_DNS_record">DNS wildcard</a> is supported as hostname.
|
|
* For example, you can use {@code *.netty.io} to match {@code netty.io} and {@code downloads.netty.io}.
|
|
* </p>
|
|
*
|
|
* @param hostname the host name (optionally wildcard)
|
|
* @param output the output value that will be returned by {@link DomainNameMapping#map(String)}
|
|
* when the specified host name matches the specified input host name
|
|
*/
|
|
public DomainMappingBuilder<V> add(String hostname, V output) {
|
|
builder.add(hostname, output);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Creates a new instance of immutable {@link DomainNameMapping}
|
|
* Attempts to add new mappings to the result object will cause {@link UnsupportedOperationException} to be thrown
|
|
*
|
|
* @return new {@link DomainNameMapping} instance
|
|
*/
|
|
public DomainNameMapping<V> build() {
|
|
return builder.build();
|
|
}
|
|
}
|