SanitizedType (Closure Templates)

java.lang.Object
- com.google.template.soy.types.primitive.SanitizedType

All Implemented Interfaces:

SoyType

Direct Known Subclasses:

SanitizedType.AttributesType, SanitizedType.CssType, SanitizedType.HtmlType, SanitizedType.JsType, SanitizedType.TrustedResourceUriType, SanitizedType.UriType
```
public abstract class SanitizedType
extends Object
```
Implementation of types for sanitized strings, that is strings that are produced by templates having a "kind" attribute. All of these types may be implicitly coerced into strings.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SanitizedType.AttributesType` Type produced by templates whose kind is "attributes".
`static class`	`SanitizedType.CssType` Type produced by templates whose kind is "css".
`static class`	`SanitizedType.HtmlType` Type produced by templates whose kind is "html".
`static class`	`SanitizedType.JsType` Type produced by templates whose kind is "js".
`static class`	`SanitizedType.TrustedResourceUriType` Type produced by templates whose kind is "trustedResourceUri".
`static class`	`SanitizedType.UriType` Type produced by templates whose kind is "uri".

Nested classes/interfaces inherited from interface com.google.template.soy.types.SoyType
SoyType.Kind

Constructor Summary

Constructors
Constructor and Description

SanitizedType()

Constructors
Constructor and Description
`SanitizedType()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`abstract SanitizedContent.ContentKind`	`getContentKind()` Returns the content kind for this type.
`static SoyType`	`getTypeForContentKind(SanitizedContent.ContentKind contentKind)` Given a content kind, return the corresponding soy type.
`int`	`hashCode()`
`boolean`	`isAssignableFrom(SoyType srcType)` Returns true if a parameter or field of this type can be assigned from a value of `srcType`.
`boolean`	`isInstance(SoyValue value)` Returns true if the given value is an instance of this type.
`Class<? extends SoyValue>`	`javaType()` Returns the java class for the the SoyValue subclass that is used to represent this type.
`String`	`toString()`

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

Methods inherited from interface com.google.template.soy.types.SoyType
getKind

- Constructor Detail
  - SanitizedType
```
public SanitizedType()
```
- Method Detail
  - getContentKind
```
public abstract SanitizedContent.ContentKind getContentKind()
```
    Returns the content kind for this type. Guaranteed to be non-null and also not TEXT.
  - isInstance
```
public boolean isInstance(SoyValue value)
```
    Description copied from interface: SoyType
    
    Returns true if the given value is an instance of this type. For generic types, this only checks the overall shape of the type (list, map, etc) since Java type erasure does not allow the type parameters to be checked. Also, in some cases the "instanceof" test may be defined somewhat loosely - for example, sanitized types may be considered instances of type string, since they are usable in any context where a string is usable, even though internally they are not implemented as subclasses of string. This test does not take into account automatic coercions, such as converting to string or boolean.
    
    Parameters:
    value - The value to test.
    
    Returns:
    True if the value is an instance of this type.
  - javaType
```
public Class<? extends SoyValue> javaType()
```
    Description copied from interface: SoyType
    
    Returns the java class for the the SoyValue subclass that is used to represent this type.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTypeForContentKind
```
public static SoyType getTypeForContentKind(SanitizedContent.ContentKind contentKind)
```
    Given a content kind, return the corresponding soy type.
    For SanitizedContent.ContentKind.TEXT this returns StringType, for all other types it is a SanitizedType.
  - isAssignableFrom
```
public boolean isAssignableFrom(SoyType srcType)
```
    Description copied from interface: SoyType
    
    Returns true if a parameter or field of this type can be assigned from a value of srcType.
    
    Specified by:
    
    isAssignableFrom in interface SoyType
    
    Parameters:
    srcType - The type of the incoming value.
    
    Returns:
    True if the assignment is valid.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class SanitizedType

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.types.SoyType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.template.soy.types.SoyType

Constructor Detail

SanitizedType

Method Detail

getContentKind

isInstance

javaType

toString

getTypeForContentKind

isAssignableFrom

equals

hashCode