001/**
002 *
003 * Copyright the original author or authors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.pubsub.packet;
018
019import java.util.Locale;
020
021/**
022 * Defines all the valid namespaces that are used with the {@link PubSub} packet
023 * as defined by the specification.
024 * 
025 * @author Robin Collier
026 */
027public enum PubSubNamespace
028{
029        BASIC(null),
030        ERROR("errors"),
031        EVENT("event"),
032        OWNER("owner");
033        
034        private String fragment;
035        
036        private PubSubNamespace(String fragment)
037        {
038                this.fragment = fragment;
039        }
040        
041        public String getXmlns()
042        {
043                String ns = PubSub.NAMESPACE;
044                
045                if (fragment != null)
046                        ns += '#' + fragment;
047                
048                return ns;
049        }
050        
051        public String getFragment()
052        {
053                return fragment;
054        }
055
056        public static PubSubNamespace valueOfFromXmlns(String ns)
057        {
058                int index = ns.lastIndexOf('#');
059                
060                if (index != -1)
061                {
062                        String suffix = ns.substring(ns.lastIndexOf('#')+1);
063                        return valueOf(suffix.toUpperCase(Locale.US));
064                }
065                else
066                        return BASIC;
067        }
068}