1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/*
2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2009 Mike Cumings
3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *
4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Licensed under the Apache License, Version 2.0 (the "License");
5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License.
6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at
7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *
8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *   http://www.apache.org/licenses/LICENSE-2.0
9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *
10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software
11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS,
12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and
14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License.
15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */
16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage com.kenai.jbosh;
18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.HashMap;
20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Map;
21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/**
23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Data extracted from a raw XML message by a BodyParser implementation.
24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Currently, this is limited to the attributes of the wrapper element.
25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */
26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenfinal class BodyParserResults {
27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    /**
29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * Map of qualified names to their values.  This map is defined to
30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * match the requirement of the {@code Body} class to prevent
31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * excessive copying.
32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     */
33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    private final Map<BodyQName, String> attrs =
34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen            new HashMap<BodyQName, String>();
35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    /**
37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * Constructor.
38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     */
39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    BodyParserResults() {
40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen        // Empty
41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    }
42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    /**
44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * Add an attribute definition to the results.
45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     *
46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * @param name attribute's qualified name
47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * @param value attribute value
48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     */
49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    void addBodyAttributeValue(
50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen            final BodyQName name,
51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen            final String value) {
52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen        attrs.put(name, value);
53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    }
54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    /**
56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * Returns the map of attributes added by the parser.
57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     *
58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * @return map of atributes. Note: This is the live instance, not a copy.
59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     */
60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    Map<BodyQName, String> getAttributes() {
61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen        return attrs;
62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    }
63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen}
65