123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356 |
- /*--
-
- $Id: ContentFilter.java,v 1.15 2007/11/10 05:29:00 jhunter Exp $
-
- Copyright (C) 2000-2007 Jason Hunter & Brett McLaughlin.
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- 1. Redistributions of source code must retain the above copyright
- notice, this list of conditions, and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions, and the disclaimer that follows
- these conditions in the documentation and/or other materials
- provided with the distribution.
-
- 3. The name "JDOM" must not be used to endorse or promote products
- derived from this software without prior written permission. For
- written permission, please contact <request_AT_jdom_DOT_org>.
-
- 4. Products derived from this software may not be called "JDOM", nor
- may "JDOM" appear in their name, without prior written permission
- from the JDOM Project Management <request_AT_jdom_DOT_org>.
-
- In addition, we request (but do not require) that you include in the
- end-user documentation provided with the redistribution and/or in the
- software itself an acknowledgement equivalent to the following:
- "This product includes software developed by the
- JDOM Project (http://www.jdom.org/)."
- Alternatively, the acknowledgment may be graphical using the logos
- available at http://www.jdom.org/images/logos.
-
- THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
- CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- SUCH DAMAGE.
-
- This software consists of voluntary contributions made by many
- individuals on behalf of the JDOM Project and was originally
- created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
- Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
- on the JDOM Project, please see <http://www.jdom.org/>.
-
- */
-
- package org.jdom.filter;
-
- import org.jdom.*;
-
- /**
- * A general purpose Filter able to represent all legal JDOM objects or a
- * specific subset. Filtering is accomplished by way of a filtering mask in
- * which each bit represents whether a JDOM object is visible or not.
- * For example to view all Text and CDATA nodes in the content of element x.
- * <pre><code>
- * Filter filter = new ContentFilter(ContentFilter.TEXT |
- * ContentFilter.CDATA);
- * List content = x.getContent(filter);
- * </code></pre>
- * <p>
- * For those who don't like bit-masking, set methods are provided as an
- * alternative. For example to allow everything except Comment nodes.
- * <pre><code>
- * Filter filter = new ContentFilter();
- * filter.setCommentVisible(false);
- * List content = x.getContent(filter);
- * </code></pre>
- * <p>
- * The default is to allow all valid JDOM objects.
- *
- * @version $Revision: 1.15 $, $Date: 2007/11/10 05:29:00 $
- * @author Bradley S. Huffman
- */
- public class ContentFilter extends AbstractFilter {
-
- private static final String CVS_ID =
- "@(#) $RCSfile: ContentFilter.java,v $ $Revision: 1.15 $ $Date: 2007/11/10 05:29:00 $ $Name: jdom_1_1 $";
-
- /** Mask for JDOM {@link Element} objects */
- public static final int ELEMENT = 1;
-
- /** Mask for JDOM {@link CDATA} objects */
- public static final int CDATA = 2;
-
- /** Mask for JDOM {@link Text} objects */
- public static final int TEXT = 4;
-
- /** Mask for JDOM {@link Comment} objects */
- public static final int COMMENT = 8;
-
- /** Mask for JDOM {@link ProcessingInstruction} objects */
- public static final int PI = 16;
-
- /** Mask for JDOM {@link EntityRef} objects */
- public static final int ENTITYREF = 32;
-
- /** Mask for JDOM {@link Document} object */
- public static final int DOCUMENT = 64;
-
- /** Mask for JDOM {@link DocType} object */
- public static final int DOCTYPE = 128;
-
- /** The JDOM object mask */
- private int filterMask;
-
- /**
- * Default constructor that allows any legal JDOM objects.
- */
- public ContentFilter() {
- setDefaultMask();
- }
-
- /**
- * Set whether all JDOM objects are visible or not.
- *
- * @param allVisible <code>true</code> all JDOM objects are visible,
- * <code>false</code> all JDOM objects are hidden.
- */
- public ContentFilter(boolean allVisible) {
- if (allVisible) {
- setDefaultMask();
- }
- else {
- filterMask &= ~filterMask;
- }
- }
-
- /**
- * Filter out JDOM objects according to a filtering mask.
- *
- * @param mask Mask of JDOM objects to allow.
- */
- public ContentFilter(int mask) {
- setFilterMask(mask);
- }
-
- /**
- * Return current filtering mask.
- *
- * @return the current filtering mask
- */
- public int getFilterMask() {
- return filterMask;
- }
-
- /**
- * Set filtering mask.
- *
- * @param mask the new filtering mask
- */
- public void setFilterMask(int mask) {
- setDefaultMask();
- filterMask &= mask;
- }
-
- /**
- * Set this filter to allow all legal JDOM objects.
- */
- public void setDefaultMask() {
- filterMask = ELEMENT | CDATA | TEXT | COMMENT |
- PI | ENTITYREF | DOCUMENT | DOCTYPE;
- }
-
- /**
- * Set filter to match only JDOM objects that are legal
- * document content.
- */
- public void setDocumentContent() {
- filterMask = ELEMENT | COMMENT | PI | DOCTYPE;
- }
-
- /**
- * Set filter to match only JDOM objects that are legal
- * element content.
- */
- public void setElementContent() {
- filterMask = ELEMENT | CDATA | TEXT |
- COMMENT | PI | ENTITYREF;
- }
-
- /**
- * Set visiblity of <code>Element</code> objects.
- *
- * @param visible whether Elements are visible, <code>true</code>
- * if yes, <code>false</code> if not
- */
- public void setElementVisible(boolean visible) {
- if (visible) {
- filterMask |= ELEMENT;
- }
- else {
- filterMask &= ~ELEMENT;
- }
- }
-
- /**
- * Set visiblity of <code>CDATA</code> objects.
- *
- * @param visible whether CDATA nodes are visible, <code>true</code>
- * if yes, <code>false</code> if not
- */
- public void setCDATAVisible(boolean visible) {
- if (visible) {
- filterMask |= CDATA;
- }
- else {
- filterMask &= ~CDATA;
- }
- }
-
- /**
- * Set visiblity of <code>Text</code> objects.
- *
- * @param visible whether Text nodes are visible, <code>true</code>
- * if yes, <code>false</code> if not
- */
- public void setTextVisible(boolean visible) {
- if (visible) {
- filterMask |= TEXT;
- }
- else {
- filterMask &= ~TEXT;
- }
- }
-
- /**
- * Set visiblity of <code>Comment</code> objects.
- *
- * @param visible whether Comments are visible, <code>true</code>
- * if yes, <code>false</code> if not
- */
- public void setCommentVisible(boolean visible) {
- if (visible) {
- filterMask |= COMMENT;
- }
- else {
- filterMask &= ~COMMENT;
- }
- }
-
- /**
- * Set visiblity of <code>ProcessingInstruction</code> objects.
- *
- * @param visible whether ProcessingInstructions are visible,
- * <code>true</code> if yes, <code>false</code> if not
- */
- public void setPIVisible(boolean visible) {
- if (visible) {
- filterMask |= PI;
- }
- else {
- filterMask &= ~PI;
- }
- }
-
- /**
- * Set visiblity of <code>EntityRef</code> objects.
- *
- * @param visible whether EntityRefs are visible, <code>true</code>
- * if yes, <code>false</code> if not
- */
- public void setEntityRefVisible(boolean visible) {
- if (visible) {
- filterMask |= ENTITYREF;
- }
- else {
- filterMask &= ~ENTITYREF;
- }
- }
-
- /**
- * Set visiblity of <code>DocType</code> objects.
- *
- * @param visible whether the DocType is visible, <code>true</code>
- * if yes, <code>false</code> if not
- */
- public void setDocTypeVisible(boolean visible) {
- if (visible) {
- filterMask |= DOCTYPE;
- }
- else {
- filterMask &= ~DOCTYPE;
- }
- }
-
- /**
- * Check to see if the object matches according to the filter mask.
- *
- * @param obj The object to verify.
- * @return <code>true</code> if the objected matched a predfined
- * set of rules.
- */
- public boolean matches(Object obj) {
- if (obj instanceof Element) {
- return (filterMask & ELEMENT) != 0;
- }
- else if (obj instanceof CDATA) { // must come before Text check
- return (filterMask & CDATA) != 0;
- }
- else if (obj instanceof Text) {
- return (filterMask & TEXT) != 0;
- }
- else if (obj instanceof Comment) {
- return (filterMask & COMMENT) != 0;
- }
- else if (obj instanceof ProcessingInstruction) {
- return (filterMask & PI) != 0;
- }
- else if (obj instanceof EntityRef) {
- return (filterMask & ENTITYREF) != 0;
- }
- else if (obj instanceof Document) {
- return (filterMask & DOCUMENT) != 0;
- }
- else if (obj instanceof DocType) {
- return (filterMask & DOCTYPE) != 0;
- }
-
- return false;
- }
-
- /**
- * Returns whether the two filters are equivalent (i.e. the
- * matching mask values are identical).
- *
- * @param obj the object to compare against
- * @return whether the two filters are equal
- */
- public boolean equals(Object obj) {
- // Generated by IntelliJ
- if (this == obj) return true;
- if (!(obj instanceof ContentFilter)) return false;
-
- final ContentFilter filter = (ContentFilter) obj;
-
- if (filterMask != filter.filterMask) return false;
-
- return true;
- }
-
- public int hashCode() {
- // Generated by IntelliJ
- return filterMask;
- }
- }
|