Merge 0c4fd39 into b5180f8

smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/DateElement.java

@@ -0,0 +1,77 @@
+/**
+ *
+ * Copyright 2020 Paul Schaub
+ *
+ * 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.jivesoftware.smackx.file_metadata.element.child;
+
+import java.util.Date;
+
+import org.jivesoftware.smack.packet.NamedElement;
+import org.jivesoftware.smack.packet.XmlEnvironment;
+import org.jivesoftware.smack.util.EqualsUtil;
+import org.jivesoftware.smack.util.HashCode;
+import org.jivesoftware.smack.util.XmlStringBuilder;
+
+import org.jxmpp.util.XmppDateTime;
+
+/**
+ * Timestamp specifying the last modified time of the file.
+ */
+public class DateElement implements NamedElement {
+
+    public static final String ELEMENT = "date";
+
+    private final Date date;
+
+    public DateElement(Date date) {
+        this.date = date;
+    }
+
+    /**
+     * Return the last modification date of the file.
+     *
+     * @return last modification date
+     */
+    public Date getDate() {
+        return date;
+    }
+
+    @Override
+    public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
+        XmlStringBuilder sb = new XmlStringBuilder(this).rightAngleBracket();
+        sb.append(XmppDateTime.formatXEP0082Date(getDate()));
+        return sb.closeElement(this);
+    }
+
+    @Override
+    public String getElementName() {
+        return ELEMENT;
+    }
+
+    @Override
+    public int hashCode() {
+        return HashCode.builder()
+                .append(getElementName())
+                .append(getDate())
+                .build();
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
+                equalsBuilder.append(getElementName(), other.getElementName())
+                        .append(getDate(), other.getDate()));
+    }
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/DescElement.java

@@ -0,0 +1,94 @@
+/**
+ *
+ * Copyright 2020 Paul Schaub
+ *
+ * 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.jivesoftware.smackx.file_metadata.element.child;
+
+import org.jivesoftware.smack.packet.NamedElement;
+import org.jivesoftware.smack.packet.XmlEnvironment;
+import org.jivesoftware.smack.util.EqualsUtil;
+import org.jivesoftware.smack.util.HashCode;
+import org.jivesoftware.smack.util.StringUtils;
+import org.jivesoftware.smack.util.XmlStringBuilder;
+
+/**
+ * A human readable description of the file. Multiple {@link DescElement DescElements} MAY be included
+ * if different xml:lang values are specified.
+ */
+public class DescElement implements NamedElement {
+
+    public static final String ELEMENT = "desc";
+
+    private final String description;
+    private final String lang;
+
+    public DescElement(String description) {
+        this(description, null);
+    }
+
+    public DescElement(String description, String lang) {
+        this.description = StringUtils.requireNotNullNorEmpty(description, "Description MUST NOT be null nor empty");
+        this.lang = lang;
+    }
+
+    /**
+     * Return the description of the file.
+     *
+     * @return description
+     */
+    public String getDescription() {
+        return description;
+    }
+
+    /**
+     * Return the language of the description or null.
+     *
+     * @return language or null
+     */
+    public String getLanguage() {
+        return lang;
+    }
+
+    @Override
+    public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
+        return new XmlStringBuilder(this)
+                .optXmlLangAttribute(getLanguage())
+                .rightAngleBracket()
+                .append(getDescription())
+                .closeElement(this);
+    }
+
+    @Override
+    public String getElementName() {
+        return ELEMENT;
+    }
+
+    @Override
+    public int hashCode() {
+        return HashCode.builder()
+                .append(getElementName())
+                .append(getLanguage())
+                .append(getDescription())
+                .build();
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
+                equalsBuilder.append(getElementName(), other.getElementName())
+                        .append(getLanguage(), other.getLanguage())
+                        .append(getDescription(), other.getDescription()));
+    }
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/DimensionsElement.java

@@ -0,0 +1,75 @@
+/**
+ *
+ * Copyright 2020 Paul Schaub
+ *
+ * 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.jivesoftware.smackx.file_metadata.element.child;
+
+import org.jivesoftware.smack.packet.NamedElement;
+import org.jivesoftware.smack.packet.XmlEnvironment;
+import org.jivesoftware.smack.util.EqualsUtil;
+import org.jivesoftware.smack.util.HashCode;
+import org.jivesoftware.smack.util.StringUtils;
+import org.jivesoftware.smack.util.XmlStringBuilder;
+
+/**
+ * Horizontal and vertical dimensions of image or video files, in pixels.
+ */
+public class DimensionsElement implements NamedElement {
+
+    public static final String ELEMENT = "dimensions";
+
+    private final String dimensions;
+
+    public DimensionsElement(String dimensions) {
+        this.dimensions = StringUtils.requireNotNullNorEmpty(dimensions, "Dimensions MUST NOT be null nor empty.");
+    }
+
+    /**
+     * Return the dimensions of the file in width by height (eg. 1920x1080).
+     *
+     * @return dimensions
+     */
+    public String getDimensions() {
+        return dimensions;
+    }
+
+    @Override
+    public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
+        return new XmlStringBuilder(this)
+                .rightAngleBracket()
+                .append(getDimensions())
+                .closeElement(this);
+    }
+
+    @Override
+    public String getElementName() {
+        return ELEMENT;
+    }
+
+    @Override
+    public int hashCode() {
+        return HashCode.builder()
+                .append(getElementName())
+                .append(getDimensions())
+                .build();
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
+                equalsBuilder.append(getElementName(), other.getElementName())
+                        .append(getDimensions(), other.getDimensions()));
+    }
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/file_metadata/element/child/LengthElement.java

@@ -0,0 +1,77 @@
+/**
+ *
+ * Copyright 2020 Paul Schaub
+ *
+ * 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.jivesoftware.smackx.file_metadata.element.child;
+
+import org.jivesoftware.smack.packet.NamedElement;
+import org.jivesoftware.smack.packet.XmlEnvironment;
+import org.jivesoftware.smack.util.EqualsUtil;
+import org.jivesoftware.smack.util.HashCode;
+import org.jivesoftware.smack.util.XmlStringBuilder;
+
+/**
+ * Length of an audio or video file, in milliseconds.
+ */
+public class LengthElement implements NamedElement {
+
+    public static final String ELEMENT = "length";
+
+    private final long length;
+
+    public LengthElement(long length) {
+        if (length < 0) {
+            throw new IllegalArgumentException("Length cannot be negative.");
+        }
+        this.length = length;
+    }
+
+    /**
+     * Return the length of the audio or video file.
+     *
+     * @return length in milliseconds
+     */
+    public long getLength() {
+        return length;
+    }
+
+    @Override
+    public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment) {
+        return new XmlStringBuilder(this)
+                .rightAngleBracket()
+                .append(Long.toString(getLength()))
+                .closeElement(this);
+    }
+
+    @Override
+    public String getElementName() {
+        return ELEMENT;
+    }
+
+    @Override
+    public int hashCode() {
+        return HashCode.builder()
+                .append(getElementName())
+                .append(getLength())
+                .build();
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        return EqualsUtil.equals(this, obj, (equalsBuilder, other) ->
+                equalsBuilder.append(getElementName(), other.getElementName())
+                        .append(getLength(), other.getLength()));
+    }
+}