1/*
2 * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.xml.internal.stream.events ;
27
28import javax.xml.stream.events.Comment;
29import javax.xml.stream.events.XMLEvent;
30
31/**
32 * This class contains information about Comment event.
33 *
34 * @author Neeraj Bajaj, Sun Microsystems.
35 */
36public class CommentEvent extends DummyEvent implements Comment {
37
38    /* String data for this event */
39    private String fText ;
40
41    public CommentEvent() {
42        init();
43    }
44
45    public CommentEvent(String text) {
46        init();
47        fText = text;
48    }
49
50    protected void init() {
51        setEventType(XMLEvent.COMMENT);
52    }
53
54    /**
55     * @return String String representation of this event
56     */
57    public String toString() {
58        return "<!--" + getText() + "-->";
59    }
60
61
62    /** Return the string data of the comment, returns empty string if it
63     * does not exist
64     * @return String
65     */
66    public String getText() {
67        return fText ;
68    }
69
70    protected void writeAsEncodedUnicodeEx(java.io.Writer writer)
71    throws java.io.IOException
72    {
73        writer.write("<!--" + getText() + "-->");
74    }
75
76}
77