Java tutorial
/* * Copyright 2007 Open Source Applications Foundation * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.osaf.cosmo.dav.property; import java.util.Set; import java.util.TreeSet; import org.apache.commons.lang.StringUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.jackrabbit.webdav.property.DavPropertyName; import org.apache.jackrabbit.webdav.xml.DomUtil; import org.apache.jackrabbit.webdav.xml.XmlSerializable; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; /** * <p> * The standard implementation of {@link} DavProperty. * </p> * <p> * Note that the attribute <code>isProtected</code> does not actually refer * to whether or not the property's value is protected from modification or * deletion from the server. Rather, it denotes whether or not the property * is included in "allprop" <code>PROFIND</code> responses. * </p> */ public class StandardDavProperty implements DavProperty, XmlSerializable { private static final Log log = LogFactory.getLog(StandardDavProperty.class); private DavPropertyName name; private Object value; private String lang; private boolean isProtected; public StandardDavProperty(DavPropertyName name, Object value) { this(name, value, null, false); } public StandardDavProperty(DavPropertyName name, Object value, String lang) { this(name, value, lang, false); } public StandardDavProperty(DavPropertyName name, Object value, boolean isProtected) { this(name, value, null, isProtected); } public StandardDavProperty(DavPropertyName name, Object value, String lang, boolean isProtected) { this.name = name; this.value = value; this.isProtected = isProtected; if (!StringUtils.isBlank(lang)) this.lang = lang; } // org.apache.jackrabbit.webdav.property.DavProperty methods public DavPropertyName getName() { return name; } public Object getValue() { return value; } public boolean isProtected() { return isProtected; } // DavProperty methods public String getLanguage() { return lang; } /** * <p> * If the property value is an <code>Element</code>, the text and character * data content of the element and every child element are concatenated. * </p> * <p> * If the property is a <code>Set</code>, the set is sorted and joined. * </p> * <p> * If the property value is otherwise not null, {@link Object.toString()} is * called upon it, and the result is returned. * </p> */ public String getValueText() { if (value == null) return null; if (value instanceof Element) { String text = DomUtil.getText((Element) value); if (text != null) return text; } if (value instanceof Set) { TreeSet<Object> sorted = new TreeSet<Object>((Set) value); return StringUtils.join(sorted, ", "); } return value.toString(); } // XmlSerializable methods /** * <p> * If the property value is an <code>Element</code>, it is imported into * the provided <code>Document</code> and returned. * </p> * <p> * If the property value is an <code>XmlSerializable</code>, the element * returned by calling {@link XmlSerializable.toXml(Document)} on the * value is appended as a child of an element representing the property. * </p> * <p> * If the property value is otherwise not null, {@link Object.toString()} is * called upon it, and the result is set as text content of an element * representing the property. * </p> * <p> * In all cases, if the property has a language, it is used to set the * <code>xml:lang</code> attribute on the property element. * </p> */ public Element toXml(Document document) { Element e = null; if (value != null && value instanceof Element) e = (Element) document.importNode((Element) value, true); else { e = getName().toXml(document); Object v = getValue(); if (v != null) { if (v instanceof XmlSerializable) e.appendChild(((XmlSerializable) v).toXml(document)); else DomUtil.setText(e, v.toString()); } } if (lang != null) DomUtil.setAttribute(e, XML_LANG, NAMESPACE_XML, lang); return e; } // our methods public int hashCode() { int hashCode = getName().hashCode(); if (getValue() != null) hashCode += getValue().hashCode(); return hashCode % Integer.MAX_VALUE; } public boolean equals(Object obj) { if (!(obj instanceof DavProperty)) return false; DavProperty prop = (DavProperty) obj; if (!getName().equals(prop.getName())) return false; return getValue() == null ? prop.getValue() == null : value.equals(prop.getValue()); } /** * <p> * Returns an instance of <code>StandardDavProperty</code> representing * the given element. The element itself is provided as the property value. * If either the element or its parent element has the attribute * <code>xml:lang</code>, that attribute's value is provided as the * property's language. The resulting property is not "protected" (i.e. * it will not appear in "allprop" <code>PROPFIND</code> responses). * </p> */ public static StandardDavProperty createFromXml(Element e) { DavPropertyName name = DavPropertyName.createFromXml(e); String lang = DomUtil.getAttribute(e, XML_LANG, NAMESPACE_XML); if (lang == null && e.getParentNode() != null && e.getParentNode().getNodeType() == Node.ELEMENT_NODE) lang = DomUtil.getAttribute((Element) e.getParentNode(), XML_LANG, NAMESPACE_XML); return new StandardDavProperty(name, e, lang); } }