com.sun.syndication.feed.atom.Person Maven / Gradle / Ivy
/*
* Copyright 2004 Sun Microsystems, Inc.
*
* 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 com.sun.syndication.feed.atom;
import com.sun.syndication.feed.impl.ObjectBean;
import com.sun.syndication.feed.module.Extendable;
import com.sun.syndication.feed.module.Module;
import com.sun.syndication.feed.module.impl.ModuleUtils;
import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;
/**
* Bean for person elements of Atom feeds.
*
* @author Alejandro Abdelnur
* @author Dave Johnson (updated for Atom 1.0)
*/
public class Person implements Cloneable,Serializable, Extendable
{
private ObjectBean _objBean;
private String _name;
private String _uri; // since Atom 1.0 (was called url)
private String _uriResolved;
private String _email;
private List _modules;
/**
* Default constructor. All properties are set to null.
*
*
*/
public Person() {
_objBean = new ObjectBean(this.getClass(),this);
}
/**
* Creates a deep 'bean' clone of the object.
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
return _objBean.clone();
}
/**
* Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
*
* @param other he reference object with which to compare.
* @return true if 'this' object is equal to the 'other' object.
*
*/
@Override
public boolean equals(Object other) {
return _objBean.equals(other);
}
/**
* Returns a hashcode value for the object.
*
* It follows the contract defined by the Object hashCode() method.
*
* @return the hashcode of the bean object.
*
*/
@Override
public int hashCode() {
return _objBean.hashCode();
}
/**
* Returns the String representation for the object.
*
* @return String representation for the object.
*
*/
@Override
public String toString() {
return _objBean.toString();
}
/**
* Returns the person name.
*
* @return the person name, null if none.
*
*/
public String getName() {
return _name;
}
/**
* Sets the personname.
*
* @param name the person name, null if none.
*
*/
public void setName(String name) {
_name = name;
}
/**
* Returns the person URL (same as {@link #getUri()})
*
* @return the person URL, null if none.
*/
public String getUrl() {
return _uri;
}
/**
* Sets the person URL (same as {@link #setUri(java.lang.String)})
*
* @param url the person URL, null if none.
*/
public void setUrl(String url) {
_uri = url;
}
public void setUriResolved(String uriResolved) {
_uriResolved = uriResolved;
}
public String getUriResolved(String resolveURI) {
return _uriResolved != null ? _uriResolved : _uri;
}
/**
* Returns the person email.
*
* @return the person email, null if none.
*
*/
public String getEmail() {
return _email;
}
/**
* Sets the person email.
*
* @param email the person email, null if none.
*
*/
public void setEmail(String email) {
_email = email;
}
/**
* Returns the uri
*
* @return Returns the uri.
* @since Atom 1.0
*/
public String getUri() {
return _uri;
}
/**
* Set the uri
*
* @param uri The uri to set.
* @since Atom 1.0
*/
public void setUri(String uri) {
_uri = uri;
}
/**
* Returns the entry modules.
*
* @return a list of ModuleImpl elements with the entry modules,
* an emtpy list if none.
*
*/
public List getModules() {
return (_modules==null) ? (_modules=new ArrayList()) : _modules;
}
/**
* Sets the entry modules.
*
* @param modules the list of ModuleImpl elements with the entry modules to set,
* an empty list or null if none.
*
*/
public void setModules(List modules) {
_modules = modules;
}
/**
* Returns the module identified by a given URI.
*
* @param uri the URI of the ModuleImpl.
* @return The module with the given URI, null if none.
*/
public Module getModule(String uri) {
return ModuleUtils.getModule(_modules,uri);
}
}