ModelBuilders (Atlassian Marketplace Client 2.0.0 API)

java.lang.Object
- com.atlassian.marketplace.client.model.ModelBuilders

```
public abstract class ModelBuilders
extends Object
```
Classes for constructing model objects for the 2.0 API. Although model objects are usually returned to you by API methods, you may want to construct them yourself in order to create or update them on the server (such as creating a new add-on). You should only ever construct these objects using the builders provided here; do not try to use their constructors directly.
The general pattern for using these builders is: 1. call a builder factory method, such as addon(), which returns a builder of the appropriate type; 2. call property setter methods on the builder, such as ModelBuilders.AddonBuilder.name(String); 3. after setting all the desired properties, call the builder's build() method, which returns the finished object. Note that the builder factory methods can also be given an existing object as a parameter, in which case they initialize the builder by copying all of its properties from the existing object.
If you have omitted any required property, build() will throw an ModelBuilders.InvalidModelException. (You can easily identify required properties because they do not use the Option type; properties in this library are never nullable, so if a property is a String rather than an Option<String>, it must have a value.) Optional properties always default to Option.none() if you do not specify a value.
For some very simple objects, the factory methods construct and return a finished object rather than returning a builder.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ModelBuilders.AddonBuilder`
`static class`	`ModelBuilders.AddonVersionBuilder`
`static class`	`ModelBuilders.AddressBuilder`
`static class`	`ModelBuilders.ApplicationVersionBuilder`
`static class`	`ModelBuilders.BuilderWithLinks<T extends ModelBuilders.BuilderWithLinks<T>>`
`static class`	`ModelBuilders.HighlightBuilder`
`static class`	`ModelBuilders.InvalidModelException` `ModelBuilders` methods that declare this checked exception will throw it if you attempt to construct a model object that does not conform to the Marketplace API schema, for instance by omitting a required property.
`static class`	`ModelBuilders.LinksBuilder`
`static interface`	`ModelBuilders.SafeBuilder<T>` Common interface for builders that will always succeed in building an object; any required properties that you do not set will be given default values.
`static class`	`ModelBuilders.ScreenshotBuilder`
`static interface`	`ModelBuilders.UnsafeBuilder<T>` Common interface for builders that do not provide any default values for required properties, and will throw an exception if you try to call `build()` before you have set all the required properties.
`static class`	`ModelBuilders.UnsafeBuilderWithLinks<A,T extends ModelBuilders.UnsafeBuilderWithLinks<A,T>>`
`static class`	`ModelBuilders.VendorBuilder`

Method Summary

Methods
Modifier and Type	Method and Description
`static ModelBuilders.AddonBuilder`	`addon()` Creates a new `ModelBuilders.AddonBuilder`.
`static ModelBuilders.AddonBuilder`	`addon(Addon from)` Creates a new `ModelBuilders.AddonBuilder` initialized from the properties of an existing `Addon`.
`static ModelBuilders.AddonVersionBuilder`	`addonVersion()` Creates a new `ModelBuilders.AddonVersionBuilder`.
`static ModelBuilders.AddonVersionBuilder`	`addonVersion(AddonVersion from)` Creates a new `ModelBuilders.AddonVersionBuilder` initialized from the properties of an existing `AddonVersion`.
`static ModelBuilders.AddressBuilder`	`address()` Creates a new `ModelBuilders.AddressBuilder`.
`static ModelBuilders.ApplicationVersionBuilder`	`applicationVersion()` Creates a new `ModelBuilders.ApplicationVersionBuilder`.
`static ModelBuilders.ApplicationVersionBuilder`	`applicationVersion(ApplicationVersion from)` Creates a new `ModelBuilders.ApplicationVersionBuilder` initialized from the properties of an existing `ApplicationVersion`.
`static ModelBuilders.HighlightBuilder`	`highlight()` Creates a new `ModelBuilders.HighlightBuilder`.
`static ModelBuilders.LinksBuilder`	`links()` Creates a new `ModelBuilders.LinksBuilder`.
`static ModelBuilders.ScreenshotBuilder`	`screenshot()` Creates a new `ModelBuilders.ScreenshotBuilder`.
`static ModelBuilders.VendorBuilder`	`vendor()` Creates a new `ModelBuilders.VendorBuilder`.
`static ModelBuilders.VendorBuilder`	`vendor(Vendor from)` Creates a new `ModelBuilders.VendorBuilder` initialized from the properties of an existing `Vendor`.
`static VersionCompatibility`	`versionCompatibilityForCloud(ApplicationKey appKey)` Creates a `VersionCompatibility` that specifies compatibility with an application in Cloud hosting only.
`static VersionCompatibility`	`versionCompatibilityForServer(ApplicationKey appKey, int minBuild, int maxBuild)` Creates a `VersionCompatibility` that specifies compatibility with an application in Server hosting only.
`static VersionCompatibility`	`versionCompatibilityForServerAndCloud(ApplicationKey appKey, int minBuild, int maxBuild)` Creates a `VersionCompatibility` that specifies compatibility with an application in both Cloud and Server hosting, specifying the application version range for Server hosting as a minimum and maximum build number (this value comes from `ApplicationVersion.getBuildNumber()`).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addon
```
public static ModelBuilders.AddonBuilder addon()
```
    Creates a new ModelBuilders.AddonBuilder.
    
    Since:
    
    2.0.0
  - addon
```
public static ModelBuilders.AddonBuilder addon(Addon from)
```
    Creates a new ModelBuilders.AddonBuilder initialized from the properties of an existing Addon.
    
    Since:
    
    2.0.0
  - addonVersion
```
public static ModelBuilders.AddonVersionBuilder addonVersion()
```
    Creates a new ModelBuilders.AddonVersionBuilder.
    
    Since:
    
    2.0.0
  - addonVersion
```
public static ModelBuilders.AddonVersionBuilder addonVersion(AddonVersion from)
```
    Creates a new ModelBuilders.AddonVersionBuilder initialized from the properties of an existing AddonVersion.
    
    Since:
    
    2.0.0
  - address
```
public static ModelBuilders.AddressBuilder address()
```
    Creates a new ModelBuilders.AddressBuilder.
    
    Since:
    
    2.0.0
  - applicationVersion
```
public static ModelBuilders.ApplicationVersionBuilder applicationVersion()
```
    Creates a new ModelBuilders.ApplicationVersionBuilder.
    
    Since:
    
    2.0.0
  - applicationVersion
```
public static ModelBuilders.ApplicationVersionBuilder applicationVersion(ApplicationVersion from)
```
    Creates a new ModelBuilders.ApplicationVersionBuilder initialized from the properties of an existing ApplicationVersion.
    
    Since:
    
    2.0.0
  - highlight
```
public static ModelBuilders.HighlightBuilder highlight()
```
    Creates a new ModelBuilders.HighlightBuilder.
    
    Since:
    
    2.0.0
  - links
```
public static ModelBuilders.LinksBuilder links()
```
    Creates a new ModelBuilders.LinksBuilder.
    
    Since:
    
    2.0.0
  - screenshot
```
public static ModelBuilders.ScreenshotBuilder screenshot()
```
    Creates a new ModelBuilders.ScreenshotBuilder.
    
    Since:
    
    2.0.0
  - vendor
```
public static ModelBuilders.VendorBuilder vendor()
```
    Creates a new ModelBuilders.VendorBuilder.
    
    Since:
    
    2.0.0
  - vendor
```
public static ModelBuilders.VendorBuilder vendor(Vendor from)
```
    Creates a new ModelBuilders.VendorBuilder initialized from the properties of an existing Vendor.
    
    Since:
    
    2.0.0
  - versionCompatibilityForCloud
```
public static VersionCompatibility versionCompatibilityForCloud(ApplicationKey appKey)
```
    Creates a VersionCompatibility that specifies compatibility with an application in Cloud hosting only. For Cloud hosting, there is no application version range.
    
    Since:
    
    2.0.0
  - versionCompatibilityForServer
```
public static VersionCompatibility versionCompatibilityForServer(ApplicationKey appKey,
                                                 int minBuild,
                                                 int maxBuild)
```
    Creates a VersionCompatibility that specifies compatibility with an application in Server hosting only. For Server hosting, you must specify the application version range as a minimum and maximum build number (this value comes from ApplicationVersion.getBuildNumber()).
    
    Since:
    
    2.0.0
  - versionCompatibilityForServerAndCloud
```
public static VersionCompatibility versionCompatibilityForServerAndCloud(ApplicationKey appKey,
                                                         int minBuild,
                                                         int maxBuild)
```
    Creates a VersionCompatibility that specifies compatibility with an application in both Cloud and Server hosting, specifying the application version range for Server hosting as a minimum and maximum build number (this value comes from ApplicationVersion.getBuildNumber()).
    
    Since:
    
    2.0.0

Class ModelBuilders

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addon

addon

addonVersion

addonVersion

address

applicationVersion

applicationVersion

highlight

links

screenshot

vendor

vendor

versionCompatibilityForCloud

versionCompatibilityForServer

versionCompatibilityForServerAndCloud