org.apache.juneau.dto.atom.Link Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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.apache.juneau.dto.atom;
import static org.apache.juneau.xml.annotation.XmlFormat.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.xml.annotation.*;
/**
* Represents an atomLink construct in the RFC4287 specification.
*
* Schema
*
* atomLink =
* element atom:link {
* atomCommonAttributes,
* attribute href { atomUri },
* attribute rel { atomNCName | atomUri }?,
* attribute type { atomMediaType }?,
* attribute hreflang { atomLanguageTag }?,
* attribute title { text }?,
* attribute length { text }?,
* undefinedContent
* }
*
*
* See Also:
*/
@Bean(typeName="link")
@FluentSetters
public class Link extends Common {
private String href;
private String rel;
private String type;
private String hreflang;
private String title;
private Integer length;
/**
* Normal constructor.
*
* @param rel The rel of the link.
* @param type The type of the link.
* @param href The URI of the link.
*/
public Link(String rel, String type, String href) {
setRel(rel).setType(type).setHref(href);
}
/** Bean constructor. */
public Link() {}
//-----------------------------------------------------------------------------------------------------------------
// Bean properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Bean property getter: href .
*
*
* The href of the target of this link.
*
* @return The property value, or null if it is not set.
*/
@Xml(format=ATTR)
public String getHref() {
return href;
}
/**
* Bean property setter: href .
*
*
* The href of the target of this link.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Link setHref(String value) {
this.href = value;
return this;
}
/**
* Bean property getter: rel .
*
*
* The rel of this link.
*
* @return The property value, or null if it is not set.
*/
@Xml(format=ATTR)
public String getRel() {
return rel;
}
/**
* Bean property setter: rel .
*
*
* The rel of this link.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Link setRel(String value) {
this.rel = value;
return this;
}
/**
* Bean property getter: type .
*
*
* The content type of the target of this link.
*
* @return The property value, or null if it is not set.
*/
@Xml(format=ATTR)
public String getType() {
return type;
}
/**
* Bean property setter: type .
*
*
* The content type of the target of this link.
*
*
* Must be one of the following:
*
* "text"
* "html"
* "xhtml"
* null (defaults to "text" )
*
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Link setType(String value) {
this.type = value;
return this;
}
/**
* Bean property getter: hreflang .
*
*
* The language of the target of this link.
*
* @return The property value, or null if it is not set.
*/
@Xml(format=ATTR)
public String getHreflang() {
return hreflang;
}
/**
* Bean property setter: hreflang .
*
*
* The language of the target of this link.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Link setHreflang(String value) {
this.hreflang = value;
return this;
}
/**
* Bean property getter: title .
*
*
* The title of the target of this link.
*
* @return The property value, or null if it is not set.
*/
@Xml(format=ATTR)
public String getTitle() {
return title;
}
/**
* Bean property setter: title .
*
*
* The title of the target of this link.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Link setTitle(String value) {
this.title = value;
return this;
}
/**
* Bean property getter: length .
*
*
* The length of the contents of the target of this link.
*
* @return The property value, or null if it is not set.
*/
@Xml(format=ATTR)
public Integer getLength() {
return length;
}
/**
* Bean property setter: length .
*
*
* The length of the contents of the target of this link.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object
*/
public Link setLength(Integer value) {
this.length = value;
return this;
}
//-----------------------------------------------------------------------------------------------------------------
// Overridden setters (to simplify method chaining)
//-----------------------------------------------------------------------------------------------------------------
//
@Override /* GENERATED - org.apache.juneau.dto.atom.Common */
public Link setBase(Object value) {
super.setBase(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.dto.atom.Common */
public Link setLang(String value) {
super.setLang(value);
return this;
}
//
}