org.apache.juneau.xml.Namespace Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF 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 org.apache.juneau.xml;
import java.util.*;
import java.util.concurrent.*;
import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.internal.*;
/**
* Represents a simple namespace mapping between a simple name and URI.
*
*
* In general, the simple name will be used as the XML prefix mapping unless there are conflicts or prefix re-mappings
* in the serializer.
*/
@Bean(sort=true)
public final class Namespace {
private static final ConcurrentHashMap CACHE = new ConcurrentHashMap<>();
/**
* Create a {@link Namespace} with the specified name and URI.
*
*
* Previously-encountered name/uri pairs return a cached copy.
*
* @param name The namespace name. See {@link Namespace#getName()}.
* @param uri The namespace URI. See {@link Namespace#getUri()}.
* @return The namespace object.
*/
public static Namespace create(String name, String uri) {
String key = name + ":" + uri;
Namespace n = CACHE.get(key);
if (n == null) {
n = new Namespace(key, name, uri);
Namespace n2 = CACHE.putIfAbsent(key, n);
return (n2 == null ? n : n2);
}
return n;
}
/**
* Create a {@link Namespace} from a "name:uri" string pair.
*
* @param key The key/pair string.
* @return The namespace object.
*/
public static Namespace create(String key) {
Namespace n = CACHE.get(key);
if (n != null)
return n;
int i = key.indexOf(':');
if (i == -1)
return create(key, null);
if (key.startsWith("http://") || key.startsWith("https://"))
return create(null, key);
return create(key.substring(0, i).trim(), key.substring(i+1).trim());
}
/**
* Converts the specified object into a {@link Namespace} object.
*
*
* Can be any of following types:
*
* - A {@link Namespace} object
*
- A string containing a name/value pair of the form
"name:uri" .
*
*
* @param o The input.
* @return The namespace object, or null if the input was null or an empty JSON object.
*/
public static Namespace create(Object o) {
if (o == null)
return null;
if (o instanceof Namespace)
return (Namespace)o;
if (o instanceof CharSequence)
return create(o.toString());
throw new FormattedRuntimeException("Invalid object type passed to Namespace.create(Object): ''{0}''", o.getClass());
}
/**
* Converts the specified object into an array of {@link Namespace} object.
*
*
* Can be any of following types:
*
* - A {@link Namespace} array
*
- A comma-delimited string with key/value pairs of the form
"name:uri" .
* - A
Collection containing any of object that can be passed to {@link #createArray(Object)}.
*
*
* @param o The input.
* @return The namespace objects, or null if the input was null or an empty JSON object.
*/
@SuppressWarnings("rawtypes")
public static Namespace[] createArray(Object o) {
if (o instanceof Namespace[])
return (Namespace[])o;
if (o instanceof CharSequence) {
String[] ss = StringUtils.split(o.toString());
Namespace[] n = new Namespace[ss.length];
for (int i = 0; i < ss.length; i++)
n[i] = create(ss[i]);
return n;
}
if (o instanceof Collection) {
Collection c = (Collection)o;
Namespace[] n = new Namespace[c.size()];
int i = 0;
for (Object o2 : c){
if (o2 instanceof Namespace)
n[i] = (Namespace)o2;
else if (o2 instanceof CharSequence)
n[i] = create(o2.toString());
else
throw new FormattedRuntimeException("Invalid type passed to NamespaceFactory.createArray: ''{0}''", o);
}
return n;
}
throw new FormattedRuntimeException("Invalid type passed to NamespaceFactory.createArray: ''{0}''", o);
}
final String key, name, uri;
/**
* Constructor.
*
* @param name The short name of this schema.
* @param uri The URI of this schema.
*/
private Namespace(String key, String name, String uri) {
this.key = key;
this.name = name;
this.uri = uri;
}
/**
* Returns the namespace name.
*
* @return The namespace name.
*/
public String getName() {
return name;
}
/**
* Returns the namespace URI.
*
* @return The namespace URI.
*/
public String getUri() {
return uri;
}
@Override /* Object */
public String toString() {
return key;
}
}