1/*
2 * Copyright (C) 2010 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef WebIDBKeyPath_h
27#define WebIDBKeyPath_h
28
29#include "WebCommon.h"
30#include "WebIDBTypes.h"
31#include "WebPrivateOwnPtr.h"
32#include "WebString.h"
33#include "WebVector.h"
34
35namespace blink {
36
37class IDBKeyPath;
38
39class WebIDBKeyPath {
40public:
41    BLINK_EXPORT static WebIDBKeyPath create(const WebString&);
42    BLINK_EXPORT static WebIDBKeyPath create(const WebVector<WebString>&);
43    BLINK_EXPORT static WebIDBKeyPath createNull();
44
45    WebIDBKeyPath(const WebIDBKeyPath& keyPath) { assign(keyPath); }
46    virtual ~WebIDBKeyPath() { reset(); }
47    WebIDBKeyPath& operator=(const WebIDBKeyPath& keyPath)
48    {
49        assign(keyPath);
50        return *this;
51    }
52
53    BLINK_EXPORT void reset();
54    BLINK_EXPORT void assign(const WebIDBKeyPath&);
55
56    BLINK_EXPORT bool isValid() const;
57    BLINK_EXPORT WebIDBKeyPathType keyPathType() const;
58    BLINK_EXPORT WebVector<WebString> array() const; // Only valid for ArrayType.
59    BLINK_EXPORT WebString string() const; // Only valid for StringType.
60
61#if BLINK_IMPLEMENTATION
62    WebIDBKeyPath(const IDBKeyPath&);
63    WebIDBKeyPath& operator=(const IDBKeyPath&);
64    operator const IDBKeyPath&() const;
65#endif
66
67private:
68    WebPrivateOwnPtr<IDBKeyPath> m_private;
69};
70
71} // namespace blink
72
73#endif // WebIDBKeyPath_h
74