KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jeantessier > diff > DocumentableDifferences


1 /*
2  * Copyright (c) 2001-2005, Jean Tessier
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Jean Tessier nor the names of his contributors
17  * may be used to endorse or promote products derived from this software
18  * without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 package com.jeantessier.diff;
34
35 import org.apache.log4j.*;
36
37 import com.jeantessier.classreader.*;
38
39 /**
40  * Documents the difference, if any, for a given programming
41  * element that can be added or removed from the published
42  * documentation for the API.
43  */
44 public class DocumentableDifferences extends DecoratorDifferences {
45     private boolean newDocumentation;
46     private boolean removedDocumentation;
47
48     /**
49      * Only the DifferencesFactory can create instances of this class.
50      */
51     DocumentableDifferences(Differences component, Validator oldValidator, Validator newValidator) {
52         super(component);
53
54         Logger.getLogger(getClass()).debug("Begin " + getName());
55
56         setNewDocumentation(!oldValidator.isAllowed(component.getName()) && newValidator.isAllowed(component.getName()));
57         setRemovedDocumentation(oldValidator.isAllowed(component.getName()) && !newValidator.isAllowed(component.getName()));
58
59         Logger.getLogger(getClass()).debug("End " + getName() + ": " + (isEmpty() ? "empty" : "not empty"));
60     }
61
62     public boolean isNewDocumentation() {
63         Logger.getLogger(getClass()).debug(getName() + " NewDocumentation(): " + newDocumentation);
64         return newDocumentation;
65     }
66
67     public void setNewDocumentation(boolean newDocumentation) {
68         this.newDocumentation = newDocumentation;
69     }
70
71     public boolean isRemovedDocumentation() {
72         Logger.getLogger(getClass()).debug(getName() + " RemovedDocumentation(): " + removedDocumentation);
73         return removedDocumentation;
74     }
75
76     public void setRemovedDocumentation(boolean removedDocumentation) {
77         this.removedDocumentation = removedDocumentation;
78     }
79
80     public boolean isEmpty() {
81         return
82             !isNewDocumentation() &&
83             !isRemovedDocumentation() &&
84             getComponent().isEmpty();
85     }
86
87     public void accept(Visitor visitor) {
88         visitor.visitDocumentableDifferences(this);
89     }
90 }
91
Popular Tags