com.amazonaws.codegen.model.intermediate.MemberModel Maven / Gradle / Ivy
/*
* Copyright (c) 2016. Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.amazonaws.codegen.model.intermediate;
import static com.amazonaws.codegen.internal.Constants.LINE_SEPARATOR;
import static com.amazonaws.codegen.internal.DocumentationUtils.DEFAULT_FLUENT_RETURN;
import static com.amazonaws.codegen.internal.DocumentationUtils.DEFAULT_GETTER;
import static com.amazonaws.codegen.internal.DocumentationUtils.DEFAULT_GETTER_PARAM;
import static com.amazonaws.codegen.internal.DocumentationUtils.DEFAULT_SETTER;
import static com.amazonaws.codegen.internal.DocumentationUtils.DEFAULT_SETTER_PARAM;
import static com.amazonaws.codegen.internal.DocumentationUtils.LIST_VARARG_ADDITIONAL_DOC;
import static com.amazonaws.codegen.internal.DocumentationUtils.stripHTMLTags;
import com.amazonaws.codegen.internal.TypeUtils;
import com.amazonaws.protocol.MarshallingInfo;
import com.amazonaws.transform.JsonUnmarshallerContext;
import com.amazonaws.transform.PathMarshallers;
import com.fasterxml.jackson.annotation.JsonIgnore;
public class MemberModel extends DocumentationModel {
private String name;
private String c2jName;
private String c2jShape;
private VariableModel variable;
private VariableModel setterModel;
private String getterMethodName;
private String setterMethodName;
private String fluentSetterMethodName;
private ReturnTypeModel getterModel;
private ParameterHttpMapping http;
private boolean deprecated;
private boolean endpointDiscoveryId;
private boolean sensitive;
private ListModel listModel;
private MapModel mapModel;
private String enumType;
private String xmlNameSpaceUri;
private boolean idempotencyToken;
private ShapeModel shape;
private boolean isJsonValue;
private boolean shouldEmitLegacyEnumSetter;
private boolean shouldFullyQualify = false;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public MemberModel withName(String name) {
setName(name);
return this;
}
public String getC2jName() {
return c2jName;
}
public void setC2jName(String c2jName) {
this.c2jName = c2jName;
}
public MemberModel withC2jName(String c2jName) {
setC2jName(c2jName);
return this;
}
public String getC2jShape() {
return c2jShape;
}
public void setC2jShape(String c2jShape) {
this.c2jShape = c2jShape;
}
public MemberModel withC2jShape(String c2jShape) {
setC2jShape(c2jShape);
return this;
}
public VariableModel getVariable() {
return variable;
}
public void setVariable(VariableModel variable) {
this.variable = variable;
}
public MemberModel withVariable(VariableModel variable) {
setVariable(variable);
return this;
}
public VariableModel getSetterModel() {
return setterModel;
}
public void setSetterModel(VariableModel setterModel) {
this.setterModel = setterModel;
}
public MemberModel withSetterModel(VariableModel setterModel) {
setSetterModel(setterModel);
return this;
}
public String getGetterMethodName() {
return getterMethodName;
}
public void setGetterMethodName(String getterMethodName) {
this.getterMethodName = getterMethodName;
}
public MemberModel withGetterMethodName(String getterMethodName) {
setGetterMethodName(getterMethodName);
return this;
}
public String getSetterMethodName() {
return setterMethodName;
}
public void setSetterMethodName(String setterMethodName) {
this.setterMethodName = setterMethodName;
}
public MemberModel withSetterMethodName(String setterMethodName) {
setSetterMethodName(setterMethodName);
return this;
}
public String getFluentSetterMethodName() {
return fluentSetterMethodName;
}
public void setFluentSetterMethodName(String fluentSetterMethodName) {
this.fluentSetterMethodName = fluentSetterMethodName;
}
public MemberModel withFluentSetterMethodName(String fluentMethodName) {
setFluentSetterMethodName(fluentMethodName);
return this;
}
public ReturnTypeModel getGetterModel() {
return getterModel;
}
public void setGetterModel(ReturnTypeModel getterModel) {
this.getterModel = getterModel;
}
public MemberModel withGetterModel(ReturnTypeModel getterModel) {
setGetterModel(getterModel);
return this;
}
public ParameterHttpMapping getHttp() {
return http;
}
public void setHttp(ParameterHttpMapping parameterHttpMapping) {
this.http = parameterHttpMapping;
}
public boolean isSimple() {
return TypeUtils.isSimple(variable.getVariableType());
}
public boolean isList() {
return listModel != null;
}
public boolean isMap() {
return mapModel != null;
}
public boolean isDeprecated() {
return deprecated;
}
public void setDeprecated(boolean deprecated) {
this.deprecated = deprecated;
}
public boolean isSensitive() {
return sensitive;
}
public void setSensitive(boolean sensitive) {
this.sensitive = sensitive;
}
public boolean isEndpointDiscoveryId() {
return endpointDiscoveryId;
}
public void setEndpointDiscoveryId(boolean endpointDiscoveryId) {
this.endpointDiscoveryId = endpointDiscoveryId;
}
public ListModel getListModel() {
return listModel;
}
public void setListModel(ListModel listModel) {
this.listModel = listModel;
}
public MapModel getMapModel() {
return mapModel;
}
public MemberModel withListModel(ListModel list) {
setListModel(list);
return this;
}
public void setMapModel(MapModel map) {
this.mapModel = map;
}
public MemberModel withMapModel(MapModel map) {
setMapModel(map);
return this;
}
public String getEnumType() {
return enumType;
}
public void setEnumType(String enumType) {
this.enumType = enumType;
}
public MemberModel withEnumType(String enumType) {
setEnumType(enumType);
return this;
}
public String getXmlNameSpaceUri() {
return xmlNameSpaceUri;
}
public void setXmlNameSpaceUri(String xmlNameSpaceUri) {
this.xmlNameSpaceUri = xmlNameSpaceUri;
}
public MemberModel withXmlNameSpaceUri(String xmlNameSpaceUri) {
setXmlNameSpaceUri(xmlNameSpaceUri);
return this;
}
public String getSetterDocumentation() {
StringBuilder docBuilder = new StringBuilder("/**");
docBuilder.append(getSetterDoc())
.append(getSetterGuidanceDoc())
.append(getParamDoc())
.append(getEnumDoc())
.append("*/");
return docBuilder.toString();
}
public String getGetterDocumentation() {
StringBuilder docBuilder = new StringBuilder("/**");
docBuilder.append(documentation != null ? documentation : DEFAULT_GETTER.replace("%s", name))
.append(LINE_SEPARATOR);
if (isJsonValue()) {
docBuilder.append("")
.append(LINE_SEPARATOR)
.append("This field's value will be valid JSON according to RFC 7159, including the opening and closing ")
.append("braces. For example: '{\"key\": \"value\"}'.")
.append(LINE_SEPARATOR)
.append("
")
.append(LINE_SEPARATOR);
}
if ("java.nio.ByteBuffer".equals(
this.getGetterModel().getReturnType())) {
docBuilder.append("")
.append(LINE_SEPARATOR)
.append("{@code ByteBuffer}s are stateful. Calling "
+ "their {@code get} methods changes their "
+ "{@code position}. We recommend using "
+ "{@link java.nio.ByteBuffer#asReadOnlyBuffer()} "
+ "to create a read-only view of the buffer with "
+ "an independent {@code position}, and calling "
+ "{@code get} methods on this rather than "
+ "directly on the returned {@code ByteBuffer}. "
+ "Doing so will ensure that anyone else using "
+ "the {@code ByteBuffer} will not be affected by "
+ "changes to the {@code position}.")
.append(LINE_SEPARATOR)
.append("
")
.append(LINE_SEPARATOR);
}
String variableDesc = documentation != null ? documentation : DEFAULT_GETTER_PARAM.replace("%s", name);
docBuilder.append("@return " + stripHTMLTags(variableDesc))
.append(getEnumDoc())
.append("*/");
return docBuilder.toString();
}
public String getFluentSetterDocumentation() {
StringBuilder docBuilder = new StringBuilder("/**");
docBuilder.append(getSetterDoc())
.append(getSetterGuidanceDoc())
.append(getParamDoc())
.append(LINE_SEPARATOR)
.append("@return " + stripHTMLTags(DEFAULT_FLUENT_RETURN))
.append(getEnumDoc())
.append("*/");
return docBuilder.toString();
}
public String getVarargSetterDocumentation() {
StringBuilder docBuilder = new StringBuilder("/**");
docBuilder.append(getSetterDoc());
if (listModel != null) {
docBuilder.append(LINE_SEPARATOR)
.append(LIST_VARARG_ADDITIONAL_DOC.replaceAll("%s", name));
}
docBuilder.append(getParamDoc())
.append(LINE_SEPARATOR)
.append("@return " + stripHTMLTags(DEFAULT_FLUENT_RETURN))
.append(getEnumDoc());
docBuilder.append("*/");
return docBuilder.toString();
}
private String getSetterDoc() {
return documentation != null
? documentation
: DEFAULT_SETTER.replace("%s", name);
}
/**
* Get the documentation that should be shared between the "with" and "set"-style methods that pertains to the type of data in
* the message. This usually instructs customers on how to properly format the data that they write to the message based on
* its type.
*/
private String getSetterGuidanceDoc() {
StringBuilder docBuilder = new StringBuilder();
if (isJsonValue()) {
docBuilder.append("")
.append(LINE_SEPARATOR)
.append("This field's value must be valid JSON according to RFC 7159, including the opening and closing ")
.append("braces. For example: '{\"key\": \"value\"}'.")
.append(LINE_SEPARATOR)
.append("
")
.append(LINE_SEPARATOR);
}
boolean isByteBuffer = "java.nio.ByteBuffer".equals(this.getGetterModel().getReturnType());
if (isByteBuffer || isJsonValue()) {
docBuilder.append("")
.append(LINE_SEPARATOR)
.append("The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the ")
.append("AWS service. Users of the SDK should not perform Base64 encoding on this field.")
.append(LINE_SEPARATOR)
.append("
")
.append(LINE_SEPARATOR);
}
if (isByteBuffer) {
docBuilder.append("")
.append(LINE_SEPARATOR)
.append("Warning: ByteBuffers returned by the SDK are mutable. " +
"Changes to the content or position of the byte buffer will be " +
"seen by all objects that have a reference to this object. " +
"It is recommended to call ByteBuffer.duplicate() or " +
"ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. " +
"This behavior will be changed in a future major version of the SDK.")
.append(LINE_SEPARATOR)
.append("
")
.append(LINE_SEPARATOR);
}
return docBuilder.toString();
}
private String getParamDoc() {
StringBuilder docBuilder = new StringBuilder();
String variableDesc = documentation != null ? documentation
: DEFAULT_SETTER_PARAM.replace("%s", name);
docBuilder.append(LINE_SEPARATOR)
.append("@param " + variable.getVariableName() + " "
+ stripHTMLTags(variableDesc));
return docBuilder.toString();
}
private String getEnumDoc() {
StringBuilder docBuilder = new StringBuilder();
if (enumType != null) {
docBuilder.append(LINE_SEPARATOR);
docBuilder.append("@see " + enumType);
}
return docBuilder.toString();
}
public boolean isIdempotencyToken() {
return idempotencyToken;
}
public void setIdempotencyToken(boolean idempotencyToken) {
this.idempotencyToken = idempotencyToken;
}
public boolean isJsonValue() {
return isJsonValue;
}
public void setJsonValue(boolean isJsonValue) {
this.isJsonValue = isJsonValue;
}
public boolean getIsBinary() {
return http.getIsStreaming() || (http.getIsPayload() && "java.nio.ByteBuffer".equals(variable.getVariableType()));
}
/**
* @return Implementation of {@link com.amazonaws.transform.PathMarshallers.PathMarshaller} to use if this
* member is bound the the URI.
* @throws IllegalStateException If this member is not bound to the URI. Templates should first check {@link
* ParameterHttpMapping#isUri()} first.
*/
@JsonIgnore
public String getPathMarshaller() {
if (!http.isUri()) {
throw new IllegalStateException("Only members bound to the URI have a path marshaller");
}
final String prefix = PathMarshallers.class.getName();
if (http.isGreedy()) {
return prefix + ".GREEDY";
} else if (isIdempotencyToken()) {
return prefix + ".IDEMPOTENCY";
} else {
return prefix + ".NON_GREEDY";
}
}
/**
* Used for JSON services. Name of the field containing the {@link MarshallingInfo} for
* this member.
*/
@JsonIgnore
public String getMarshallerBindingFieldName() {
return this.name.toUpperCase() + "_BINDING";
}
/**
* Currently used only for JSON services.
*
* @return Marshalling type to use when creating a {@link MarshallingInfo}. Must be a field of {@link
* com.amazonaws.protocol.MarshallingType}.
*/
public String getMarshallingType() {
if (isList()) {
return "LIST";
} else if (isMap()) {
return "MAP";
} else if (isJsonValue()) {
return "JSON_VALUE";
} else if (!isSimple()) {
return "STRUCTURED";
} else {
return TypeUtils.getMarshallingType(variable.getSimpleType());
}
}
/**
* Currently used only for JSON services.
*
* @return The Marshalling type to use when loading the unmarshaller from the {@link JsonUnmarshallerContext}. Must be
* a field of {@link JsonUnmarshallerContext.UnmarshallerType}. This will be null if the default simple-type
* marshaller should be used.
*/
public String getUnmarshallingType() {
if(isJsonValue()) {
return "JSON_VALUE";
}
return null;
}
/**
* Currently used only for JSON services.
*
* @return The target class a marshalling type is bound to.
*/
public String getMarshallingTargetClass() {
if (isList()) {
return "List";
} else if (isMap()) {
return "Map";
} else if (!isSimple()) {
return "StructuredPojo";
} else {
return variable.getVariableType();
}
}
@JsonIgnore
public ShapeModel getShape() {
return shape;
}
public void setShape(ShapeModel shape) {
this.shape = shape;
}
public boolean getShouldEmitLegacyEnumSetter() {
return shouldEmitLegacyEnumSetter;
}
public void setShouldEmitLegacyEnumSetter(boolean shouldEmitLegacyEnumSetter) {
this.shouldEmitLegacyEnumSetter = shouldEmitLegacyEnumSetter;
}
public void setShouldFullyQualify(boolean shouldFullyQualify) {
this.shouldFullyQualify = shouldFullyQualify;
}
public boolean getShouldFullyQualify() {
return shouldFullyQualify;
}
@Override
public String toString() {
return c2jName;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy