Allow to get existing ChannelOption / AttributeKey from String

Motivation:

We should allow to get a ChannelOption/AttributeKey from a String. This will make it a lot easier to make use of configuration files in applications.

Modifications:

- Add exists(...), newInstance(...) method to ChannelOption and AttributeKey and alter valueOf(...) to return an existing instance for a String or create one.
- Add unit tests.

Result:

Much more flexible usage of ChannelOption and AttributeKey.
This commit is contained in:
Norman Maurer 2015-02-09 09:41:56 +01:00
parent 6e508e60e7
commit 99bd43ed51
5 changed files with 192 additions and 1 deletions

View File

@ -40,8 +40,21 @@ public final class AttributeKey<T> extends AbstractConstant<AttributeKey<T>> {
}
/**
* Shortcut of {@link #valueOf(String) valueOf(firstNameComponent.getName() + "#" + secondNameComponent)}.
* Returns {@code true} if a {@link AttributeKey} exists for the given {@code name}.
*/
public static boolean exists(String name) {
return pool.exists(name);
}
/**
* Creates a new {@link AttributeKey} for the given {@param name} or fail with an
* {@link IllegalArgumentException} if a {@link AttributeKey} for the given {@param name} exists.
*/
@SuppressWarnings("unchecked")
public static <T> AttributeKey<T> newInstance(String name) {
return (AttributeKey<T>) pool.newInstance(name);
}
@SuppressWarnings("unchecked")
public static <T> AttributeKey<T> valueOf(Class<?> firstNameComponent, String secondNameComponent) {
return (AttributeKey<T>) pool.valueOf(firstNameComponent, secondNameComponent);

View File

@ -16,6 +16,8 @@
package io.netty.util;
import io.netty.util.internal.ObjectUtil;
import java.util.HashMap;
import java.util.Map;
@ -73,5 +75,42 @@ public abstract class ConstantPool<T extends Constant<T>> {
}
}
/**
* Returns {@code true} if a {@link AttributeKey} exists for the given {@code name}.
*/
public boolean exists(String name) {
ObjectUtil.checkNotNull(name, "name");
synchronized (constants) {
return constants.containsKey(name);
}
}
/**
* Creates a new {@link Constant} for the given {@param name} or fail with an
* {@link IllegalArgumentException} if a {@link Constant} for the given {@param name} exists.
*/
@SuppressWarnings("unchecked")
public T newInstance(String name) {
if (name == null) {
throw new NullPointerException("name");
}
if (name.isEmpty()) {
throw new IllegalArgumentException("empty name");
}
synchronized (constants) {
T c = constants.get(name);
if (c == null) {
c = newConstant(nextId, name);
constants.put(name, c);
nextId ++;
} else {
throw new IllegalArgumentException(String.format("'%s' is already in use", name));
}
return c;
}
}
protected abstract T newConstant(int id, String name);
}

View File

@ -0,0 +1,59 @@
/*
* 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;
import org.junit.Test;
import static org.junit.Assert.*;
public class AttributeKeyTest {
@Test
public void testExists() {
String name = "test";
assertFalse(AttributeKey.exists(name));
AttributeKey<String> attr = AttributeKey.valueOf(name);
assertTrue(AttributeKey.exists(name));
assertNotNull(attr);
}
@Test
public void testValueOf() {
String name = "test1";
assertFalse(AttributeKey.exists(name));
AttributeKey<String> attr = AttributeKey.valueOf(name);
AttributeKey<String> attr2 = AttributeKey.valueOf(name);
assertSame(attr, attr2);
}
@Test
public void testNewInstance() {
String name = "test2";
assertFalse(AttributeKey.exists(name));
AttributeKey<String> attr = AttributeKey.newInstance(name);
assertTrue(AttributeKey.exists(name));
assertNotNull(attr);
try {
AttributeKey.<String>newInstance(name);
fail();
} catch (IllegalArgumentException e) {
// expected
}
}
}

View File

@ -55,6 +55,22 @@ public final class ChannelOption<T> extends AbstractConstant<ChannelOption<T>> {
return (ChannelOption<T>) pool.valueOf(firstNameComponent, secondNameComponent);
}
/**
* Returns {@code true} if a {@link ChannelOption} exists for the given {@code name}.
*/
public static boolean exists(String name) {
return pool.exists(name);
}
/**
* Creates a new {@link ChannelOption} for the given {@param name} or fail with an
* {@link IllegalArgumentException} if a {@link ChannelOption} for the given {@param name} exists.
*/
@SuppressWarnings("unchecked")
public static <T> ChannelOption<T> newInstance(String name) {
return (ChannelOption<T>) pool.newInstance(name);
}
public static final ChannelOption<ByteBufAllocator> ALLOCATOR = valueOf("ALLOCATOR");
public static final ChannelOption<RecvByteBufAllocator> RCVBUF_ALLOCATOR = valueOf("RCVBUF_ALLOCATOR");
public static final ChannelOption<MessageSizeEstimator> MESSAGE_SIZE_ESTIMATOR = valueOf("MESSAGE_SIZE_ESTIMATOR");

View File

@ -0,0 +1,64 @@
/*
* 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.channel;
import org.junit.Test;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
public class ChannelOptionTest {
@Test
public void testExists() {
String name = "test";
assertFalse(ChannelOption.exists(name));
ChannelOption<String> option = ChannelOption.valueOf(name);
assertTrue(ChannelOption.exists(name));
assertNotNull(option);
}
@Test
public void testValueOf() {
String name = "test1";
assertFalse(ChannelOption.exists(name));
ChannelOption<String> option = ChannelOption.valueOf(name);
ChannelOption<String> option2 = ChannelOption.valueOf(name);
assertSame(option, option2);
}
@Test
public void testCreateOrFail() {
String name = "test2";
assertFalse(ChannelOption.exists(name));
ChannelOption<String> option = ChannelOption.newInstance(name);
assertTrue(ChannelOption.exists(name));
assertNotNull(option);
try {
ChannelOption.<String>newInstance(name);
fail();
} catch (IllegalArgumentException e) {
// expected
}
}
}