1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_ValidationError_H
51#define Patternist_ValidationError_H
52
53#include <private/qitem_p.h>
54#include <private/qreportcontext_p.h>
55
56QT_BEGIN_NAMESPACE
57
58namespace QPatternist
59{
60 /**
61 * @short Used for signalling casting errors.
62 *
63 * @author Frans Englich <frans.englich@nokia.com>
64 * @ingroup Patternist_xdm
65 */
66 class ValidationError : public AtomicValue
67 {
68 public:
69 typedef QExplicitlySharedDataPointer<ValidationError> Ptr;
70
71 /**
72 * Creates a ValidationError instance that represents a type error.
73 *
74 * @param description A detailed description of what that made the cast fail,
75 * if any. If @c null, which QString() creates, a generic message
76 * will be used.
77 */
78 static AtomicValue::Ptr createError(const QString &description = QString(),
79 const ReportContext::ErrorCode = ReportContext::FORG0001);
80
81 /**
82 * A human readable, translated message describing the error.
83 */
84 QString message() const;
85
86 /**
87 * @returns always @c true
88 */
89 virtual bool hasError() const;
90
91 /**
92 * Always results in an assert crash.
93 */
94 virtual ItemType::Ptr type() const;
95
96 /**
97 * Always results in an assert crash.
98 */
99 virtual QString stringValue() const;
100
101 /**
102 * @returns the error code this ValidationError represents. Typically, this
103 * is ReportContext::FORG0001.
104 */
105 ReportContext::ErrorCode errorCode() const;
106
107 protected:
108 ValidationError(const QString &msg, const ReportContext::ErrorCode code);
109
110 const QString m_message;
111 const ReportContext::ErrorCode m_code;
112 };
113}
114
115QT_END_NAMESPACE
116
117#endif
118

source code of qtxmlpatterns/src/xmlpatterns/data/qvalidationerror_p.h