ezvcard.property.Hobby Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ez-vcard Show documentation
A library that reads and writes vCards, supporting all versions of the vCard standard (2.1, 3.0, and 4.0) as well as xCard (XML-encoded vCards), hCard (HTML-encoded vCards), and jCard (JSON-encoded vCards).
There is a newer version: 0.9.6
Show newest version
package ezvcard.property;

import ezvcard.SupportedVersions;
import ezvcard.VCardVersion;
import ezvcard.parameter.HobbyLevel;
import ezvcard.parameter.VCardParameters;

/*
 Copyright (c) 2012-2023, Michael Angstadt
 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 following disclaimer in the documentation
 and/or other materials provided with the distribution. 

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS 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 COPYRIGHT OWNER OR 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.

 The views and conclusions contained in the software and documentation are those
 of the authors and should not be interpreted as representing official policies, 
 either expressed or implied, of the FreeBSD Project.
 */

/**
 * 
 * Defines a recreational activity that the person actively engages in. For
 * example, if a person has a hobby of "hockey", it would mean that he likes to
 * play hockey. Someone who just likes to watch hockey would list hockey
 * as an {@link Interest} instead.
 * 
 * 
 * 
 * Code sample
 * 
 * 
 *  * VCard vcard = new VCard();
 * 
 * Hobby hobby = new Hobby("hockey");
 * hobby.setLevel(HobbyLevel.LOW);
 * vcard.addHobby(hobby);
 * 
 * 
 * 
 * Property name: {@code HOBBY}
 * 
 * 
 * Supported versions: {@code 4.0}
 * 
 * @author Michael Angstadt
 * @see RFC 6715 p.4
 */
@SupportedVersions(VCardVersion.V4_0)
public class Hobby extends TextProperty implements HasAltId {
	/**
	 * Creates a hobby property.
	 * @param hobby the hobby (e.g. "wind surfing")
	 */
	public Hobby(String hobby) {
		super(hobby);
	}

	/**
	 * Copy constructor.
	 * @param original the property to make a copy of
	 */
	public Hobby(Hobby original) {
		super(original);
	}

	/**
	 * Gets the level at which the person practices the hobby.
	 * @return the skill level (e.g. "low") or null if not set
	 * @see VCardParameters#getLevel
	 */
	public HobbyLevel getLevel() {
		String value = parameters.getLevel();
		return (value == null) ? null : HobbyLevel.get(value);
	}

	/**
	 * Sets the level at which the person practices the hobby.
	 * @param level the level (e.g. "low") or null to remove
	 * @see VCardParameters#setLevel
	 */
	public void setLevel(HobbyLevel level) {
		parameters.setLevel(level.getValue());
	}

	@Override
	public Integer getIndex() {
		return super.getIndex();
	}

	@Override
	public void setIndex(Integer index) {
		super.setIndex(index);
	}

	/**
	 * Gets the TYPE parameter.
	 * @return the TYPE value (typically, this will be either "work" or "home")
	 * or null if it doesn't exist
	 */
	public String getType() {
		return parameters.getType();
	}

	/**
	 * Sets the TYPE parameter.
	 * @param type the TYPE value (this should be either "work" or "home") or
	 * null to remove
	 */
	public void setType(String type) {
		parameters.setType(type);
	}

	@Override
	public String getLanguage() {
		return super.getLanguage();
	}

	@Override
	public void setLanguage(String language) {
		super.setLanguage(language);
	}

	@Override
	public Integer getPref() {
		return super.getPref();
	}

	@Override
	public void setPref(Integer pref) {
		super.setPref(pref);
	}

	//@Override
	public String getAltId() {
		return parameters.getAltId();
	}

	//@Override
	public void setAltId(String altId) {
		parameters.setAltId(altId);
	}

	@Override
	public Hobby copy() {
		return new Hobby(this);
	}
}