Interface DocFuncData

All Known Implementing Classes:

AddAutoDocsInfo, AddAutoDocsInfo, AddAutoDocsInfo, AddAutoDocsInfo, AddCycleRangeAutoDocsInfo, AddCycleRangeAutoDocsInfo, AddCycleRangeAutoDocsInfo, AddHashRangeAutoDocsInfo, AddHashRangeAutoDocsInfo, AddHashRangeAutoDocsInfo, AlphaNumericStringAutoDocsInfo, BetaAutoDocsInfo, BetaAutoDocsInfo, BinomialAutoDocsInfo, BinomialAutoDocsInfo, BinomialAutoDocsInfo, BinomialAutoDocsInfo, ByteBufferSizedHashedAutoDocsInfo, ByteBufferToHexAutoDocsInfo, CauchyAutoDocsInfo, CauchyAutoDocsInfo, CharBufferExtractAutoDocsInfo, CharBufImageAutoDocsInfo, ChiSquaredAutoDocsInfo, ChiSquaredAutoDocsInfo, CircleVectorsAutoDocsInfo, CitiesAutoDocsInfo, CitiesByDensityAutoDocsInfo, CitiesByPopulationAutoDocsInfo, ClampAutoDocsInfo, ClampAutoDocsInfo, ClampAutoDocsInfo, ClearAutoDocsInfo, ClearAutoDocsInfo, CoinFuncAutoDocsInfo, CombinationsAutoDocsInfo, CombinerAutoDocsInfo, ConcatArrayAutoDocsInfo, ConcatAutoDocsInfo, ConcatChainedAutoDocsInfo, ConcatCycleAutoDocsInfo, ConcatFixedAutoDocsInfo, ConcatHashedAutoDocsInfo, ConcatSteppedAutoDocsInfo, ConstantContinuousAutoDocsInfo, ConstantContinuousAutoDocsInfo, CountiesAutoDocsInfo, CountiesByDensityAutoDocsInfo, CountiesByPopulationAutoDocsInfo, CountryCodesAutoDocsInfo, CountryNamesAutoDocsInfo, CqlDurationFunctionsAutoDocsInfo, CqlVectorAutoDocsInfo, CSVFrequencySamplerAutoDocsInfo, CSVSamplerAutoDocsInfo, CSVToCqlFloatVectorAutoDocsInfo, CurrentEpochMillisAutoDocsInfo, CurrentTimeMillisAutoDocsInfo, CycleRangeAutoDocsInfo, CycleRangeAutoDocsInfo, CycleRangeAutoDocsInfo, DateRangeDuringAutoDocsInfo, DateRangeFuncAutoDocsInfo, DateRangeOnOrAfterAutoDocsInfo, DateRangeOnOrBeforeAutoDocsInfo, DateRangeParserAutoDocsInfo, DateTimeParserAutoDocsInfo, DecimalFormatAutoDocsInfo, DelimFrequencySamplerAutoDocsInfo, DigestToByteBufferAutoDocsInfo, DigestToByteBufferAutoDocsInfo, DirectoryLinesAutoDocsInfo, DirectoryLinesStableAutoDocsInfo, DiscardAutoDocsInfo, DistanceAutoDocsInfo, DivAutoDocsInfo, DivAutoDocsInfo, DivAutoDocsInfo, DivAutoDocsInfo, DivideToLongToStringAutoDocsInfo, DNN_angular1_neighborsAutoDocsInfo, DNN_euclidean_neighborsAutoDocsInfo, DNN_euclidean_v_seriesAutoDocsInfo, DNN_euclidean_v_wrapAutoDocsInfo, DNN_euclidean_vAutoDocsInfo, DnnAngular1VAutoDocsInfo, DocForFunc, DoubleArrayCacheAutoDocsInfo, DoubleCacheAutoDocsInfo, DoubleCombinerAutoDocsInfo, DoubleToFloatAutoDocsInfo, DoubleVectorPadLeftAutoDocsInfo, DoubleVectorPadRightAutoDocsInfo, DoubleVectorPrefixAutoDocsInfo, DoubleVectorsAutoDocsInfo, DoubleVectorSuffixAutoDocsInfo, ElapsedNanoTimeAutoDocsInfo, EmpiricalDistributionAutoDocsInfo, EnumeratedAutoDocsInfo, EnumeratedAutoDocsInfo, EnumeratedIntsAutoDocsInfo, EnumeratedIntsAutoDocsInfo, EpochMillisToCqlLocalDateAutoDocsInfo, EpochMillisToJavaLocalDateAutoDocsInfo, EpochMillisToJavaLocalDateTimeAutoDocsInfo, EscapeJSONAutoDocsInfo, ExampleDocData, ExponentialAutoDocsInfo, ExponentialAutoDocsInfo, ExprAutoDocsInfo, ExprAutoDocsInfo, ExprAutoDocsInfo, ExprAutoDocsInfo, ExprAutoDocsInfo, ExprAutoDocsInfo, ExprAutoDocsInfo, FAutoDocsInfo, FAutoDocsInfo, FieldExtractorAutoDocsInfo, FirstLinesAutoDocsInfo, FirstNamesAutoDocsInfo, FixedValueAutoDocsInfo, FixedValueAutoDocsInfo, FixedValueAutoDocsInfo, FixedValuesAutoDocsInfo, FixedValuesAutoDocsInfo, FixedValuesAutoDocsInfo, FixedValuesAutoDocsInfo, FloatVectorPadLeftAutoDocsInfo, FloatVectorPadRightAutoDocsInfo, FloatVectorPrefixAutoDocsInfo, FloatVectorsAutoDocsInfo, FloatVectorSuffixAutoDocsInfo, FlowAutoDocsInfo, FormatAutoDocsInfo, FromCSVToBoxedDoubleArrayAutoDocsInfo, FromCSVToBoxedFloatArrayAutoDocsInfo, FromCSVToPrimitiveDoubleArrayAutoDocsInfo, FromCSVToPrimitiveFloatArrayAutoDocsInfo, FullHashAutoDocsInfo, FullNamesAutoDocsInfo, FVecReaderAutoDocsInfo, GammaAutoDocsInfo, GammaAutoDocsInfo, GeometricAutoDocsInfo, GeometricAutoDocsInfo, GeometricAutoDocsInfo, GeometricAutoDocsInfo, GumbelAutoDocsInfo, GumbelAutoDocsInfo, HashAutoDocsInfo, HashAutoDocsInfo, HashAutoDocsInfo, HashedByteBufferExtractAutoDocsInfo, HashedDoubleVectorsAutoDocsInfo, HashedFileExtractToStringAutoDocsInfo, HashedFloatVectorsAutoDocsInfo, HashedLinesToKeyValueStringAutoDocsInfo, HashedLineToIntAutoDocsInfo, HashedLineToStringAutoDocsInfo, HashedLineToStringListAutoDocsInfo, HashedLineToStringSetAutoDocsInfo, HashedLineToStringStringMapAutoDocsInfo, HashedLoremExtractToStringAutoDocsInfo, HashedRangedToNonuniformDoubleAutoDocsInfo, HashedRangedToNonuniformFloatAutoDocsInfo, HashedRangeToLongListAutoDocsInfo, HashedToByteBufferAutoDocsInfo, HashIntervalAutoDocsInfo, HashIntervalAutoDocsInfo, HashIntervalAutoDocsInfo, HashIntervalAutoDocsInfo, HashRangeAutoDocsInfo, HashRangeAutoDocsInfo, HashRangeAutoDocsInfo, HashRangeAutoDocsInfo, HashRangeAutoDocsInfo, HashRangeScaledAutoDocsInfo, HashRangeScaledAutoDocsInfo, HashRangeScaledAutoDocsInfo, HdfDatasetsToStringAutoDocsInfo, HdfDatasetToCqlPredicatesAutoDocsInfo, HdfDatasetToStringAutoDocsInfo, HdfDatasetToStringsAutoDocsInfo, HdfFileToFloatArrayAutoDocsInfo, HdfFileToFloatListAutoDocsInfo, HdfFileToIntArrayAutoDocsInfo, HdfFileToIntListAutoDocsInfo, HdfFileToLongArrayAutoDocsInfo, HdfFileToLongListAutoDocsInfo, HdfPredicatesToCqlAutoDocsInfo, HTMLEntityDecodeAutoDocsInfo, HTMLEntityEncodeAutoDocsInfo, HypergeometricAutoDocsInfo, HypergeometricAutoDocsInfo, HypergeometricAutoDocsInfo, HypergeometricAutoDocsInfo, IdentityAutoDocsInfo, InterpolateAutoDocsInfo, InterpolateAutoDocsInfo, IntFlowAutoDocsInfo, IVecReaderAutoDocsInfo, JoinAutoDocsInfo, JoinTemplateAutoDocsInfo, LaplaceAutoDocsInfo, LaplaceAutoDocsInfo, LastNamesAutoDocsInfo, LevyAutoDocsInfo, LevyAutoDocsInfo, LineStringAutoDocsInfo, ListAutoDocsInfo, ListFunctionsAutoDocsInfo, ListHashedAutoDocsInfo, ListSizedAutoDocsInfo, ListSizedHashedAutoDocsInfo, ListSizedSteppedAutoDocsInfo, ListSteppedAutoDocsInfo, ListTemplateAutoDocsInfo, LoadAutoDocsInfo, LoadAutoDocsInfo, LoadAutoDocsInfo, LoadAutoDocsInfo, LoadAutoDocsInfo, LoadAutoDocsInfo, LoadCqlVectorAutoDocsInfo, LoadCqlVectorFromArrayAutoDocsInfo, LoadDoubleAutoDocsInfo, LoadDoubleAutoDocsInfo, LoadElementAutoDocsInfo, LoadFloatAutoDocsInfo, LoadFloatAutoDocsInfo, LoadIntegerAutoDocsInfo, LoadIntegerAutoDocsInfo, LoadLongAutoDocsInfo, LoadLongAutoDocsInfo, LoadStringAutoDocsInfo, LoadStringAutoDocsInfo, LogisticAutoDocsInfo, LogisticAutoDocsInfo, LogNormalAutoDocsInfo, LogNormalAutoDocsInfo, LongFlowAutoDocsInfo, LongStatsAutoDocsInfo, LongToByteAutoDocsInfo, LongToLocalDateDaysAutoDocsInfo, LongToShortAutoDocsInfo, LongToStringAutoDocsInfo, MapAutoDocsInfo, MapFunctionsAutoDocsInfo, MapHashedAutoDocsInfo, MapSizedAutoDocsInfo, MapSizedHashedAutoDocsInfo, MapSizedSteppedAutoDocsInfo, MapSteppedAutoDocsInfo, MatchFuncAutoDocsInfo, MatchRegexAutoDocsInfo, MaxAutoDocsInfo, MaxAutoDocsInfo, MaxAutoDocsInfo, MinAutoDocsInfo, MinAutoDocsInfo, MinAutoDocsInfo, MirrorToStringAutoDocsInfo, ModAutoDocsInfo, ModAutoDocsInfo, ModAutoDocsInfo, ModuloCSVLineToStringAutoDocsInfo, ModuloLineToStringAutoDocsInfo, ModuloToBigDecimalAutoDocsInfo, ModuloToBigIntAutoDocsInfo, ModuloToBooleanAutoDocsInfo, ModuloToByteAutoDocsInfo, ModuloToIntegerAutoDocsInfo, ModuloToLongAutoDocsInfo, ModuloToShortAutoDocsInfo, MulAutoDocsInfo, MulAutoDocsInfo, MulAutoDocsInfo, MulAutoDocsInfo, MulAutoDocsInfo, MulAutoDocsInfo, Murmur3DivToLongAutoDocsInfo, Murmur3DivToStringAutoDocsInfo, NakagamiAutoDocsInfo, NakagamiAutoDocsInfo, NormalAutoDocsInfo, NormalAutoDocsInfo, NormalizeCqlVectorAutoDocsInfo, NormalizeDoubleListVectorAutoDocsInfo, NormalizeDoubleVectorAutoDocsInfo, NormalizeFloatListVectorAutoDocsInfo, NormalizeFloatVectorAutoDocsInfo, NormalizeListVectorAutoDocsInfo, NullIfCloseToAutoDocsInfo, NullIfEmptyAutoDocsInfo, NullIfEqAutoDocsInfo, NullIfEqAutoDocsInfo, NullIfGeAutoDocsInfo, NullIfGeAutoDocsInfo, NullIfGtAutoDocsInfo, NullIfGtAutoDocsInfo, NullIfLeAutoDocsInfo, NullIfLeAutoDocsInfo, NullIfLtAutoDocsInfo, NullIfLtAutoDocsInfo, NullIfNullOrEmptyAutoDocsInfo, NullIfWithinAutoDocsInfo, NullOrLoadAutoDocsInfo, NullOrPassAutoDocsInfo, NumberNameToStringAutoDocsInfo, ParetoAutoDocsInfo, ParetoAutoDocsInfo, PartitionLongsAutoDocsInfo, PascalAutoDocsInfo, PascalAutoDocsInfo, PascalAutoDocsInfo, PascalAutoDocsInfo, PointAutoDocsInfo, PoissonAutoDocsInfo, PoissonAutoDocsInfo, PoissonAutoDocsInfo, PoissonAutoDocsInfo, PolygonAutoDocsInfo, PolygonOnGridAutoDocsInfo, PrefixAutoDocsInfo, RepeatListAutoDocsInfo, ReplaceAllAutoDocsInfo, ReplaceRegexAutoDocsInfo, SaveAutoDocsInfo, SaveAutoDocsInfo, SaveAutoDocsInfo, SaveAutoDocsInfo, SaveAutoDocsInfo, SaveAutoDocsInfo, SaveDoubleAutoDocsInfo, SaveDoubleAutoDocsInfo, SaveFloatAutoDocsInfo, SaveFloatAutoDocsInfo, SaveIntegerAutoDocsInfo, SaveIntegerAutoDocsInfo, SaveLongAutoDocsInfo, SaveLongAutoDocsInfo, SaveStringAutoDocsInfo, SaveStringAutoDocsInfo, ScaledDoubleAutoDocsInfo, SequenceOfAutoDocsInfo, SequenceOfAutoDocsInfo, SetAutoDocsInfo, SetFunctionsAutoDocsInfo, SetHashedAutoDocsInfo, SetSizedAutoDocsInfo, SetSizedHashedAutoDocsInfo, SetSizedSteppedAutoDocsInfo, SetSteppedAutoDocsInfo, ShowAutoDocsInfo, ShowAutoDocsInfo, ShuffleAutoDocsInfo, SignalPIDAutoDocsInfo, SignedHashAutoDocsInfo, SignedHashAutoDocsInfo, SignedHashAutoDocsInfo, SinAutoDocsInfo, SnappyCompAutoDocsInfo, StartingEpochMillisAutoDocsInfo, StateCodesAutoDocsInfo, StateCodesByDensityAutoDocsInfo, StateCodesByPopulationAutoDocsInfo, StateNamesAutoDocsInfo, StateNamesByDensityAutoDocsInfo, StateNamesByPopulationAutoDocsInfo, StaticStringMapperAutoDocsInfo, StringDateWrapperAutoDocsInfo, StringFlowAutoDocsInfo, StringifyAutoDocsInfo, StringListAutoDocsInfo, StringMapAutoDocsInfo, StringSetAutoDocsInfo, SuffixAutoDocsInfo, SumFunctionsAutoDocsInfo, SwapAutoDocsInfo, SwapAutoDocsInfo, SwapAutoDocsInfo, TAutoDocsInfo, TAutoDocsInfo, TemplateAutoDocsInfo, ThreadNumAutoDocsInfo, ThreadNumAutoDocsInfo, ThreadNumToIntegerAutoDocsInfo, ThreadNumToLongAutoDocsInfo, TimeZonesAutoDocsInfo, TimeZonesByDensityAutoDocsInfo, TimeZonesByPopulationAutoDocsInfo, ToBase64AutoDocsInfo, ToBase64StringAutoDocsInfo, ToBase64StringAutoDocsInfo, ToBase64StringAutoDocsInfo, ToBigDecimalAutoDocsInfo, ToBigDecimalAutoDocsInfo, ToBigDecimalAutoDocsInfo, ToBigDecimalAutoDocsInfo, ToBigIntAutoDocsInfo, ToBooleanAutoDocsInfo, ToBooleanAutoDocsInfo, ToBooleanAutoDocsInfo, ToBooleanAutoDocsInfo, ToByteAutoDocsInfo, ToByteAutoDocsInfo, ToByteAutoDocsInfo, ToByteAutoDocsInfo, ToByteAutoDocsInfo, ToByteAutoDocsInfo, ToByteBufferAutoDocsInfo, ToByteBufferAutoDocsInfo, ToByteBufferAutoDocsInfo, ToByteBufferAutoDocsInfo, ToByteBufferAutoDocsInfo, ToByteBufferAutoDocsInfo, ToByteBufferAutoDocsInfo, ToCharBufferAutoDocsInfo, ToCqlDurationAutoDocsInfo, ToCqlDurationNanosAutoDocsInfo, ToCqlVectorAutoDocsInfo, ToCqlVectorAutoDocsInfo, ToCqlVectorAutoDocsInfo, ToDateAutoDocsInfo, ToDateTimeAutoDocsInfo, ToDoubleAutoDocsInfo, ToDoubleListAutoDocsInfo, ToEpochTimeUUIDAutoDocsInfo, ToFinestTimeUUIDAutoDocsInfo, ToFloatAutoDocsInfo, ToFloatAutoDocsInfo, ToFloatAutoDocsInfo, ToFloatAutoDocsInfo, ToFloatAutoDocsInfo, ToFloatListAutoDocsInfo, ToFloatVectorAutoDocsInfo, ToHashedUUIDAutoDocsInfo, ToHexStringAutoDocsInfo, ToHexStringAutoDocsInfo, ToInetAddressAutoDocsInfo, ToIntAutoDocsInfo, ToIntAutoDocsInfo, ToIntAutoDocsInfo, ToIntAutoDocsInfo, ToIntAutoDocsInfo, ToIntAutoDocsInfo, ToJavaInstantAutoDocsInfo, ToJodaDateTimeAutoDocsInfo, ToJodaInstantAutoDocsInfo, ToJSONAutoDocsInfo, ToJSONFAutoDocsInfo, ToJSONFPrettyAutoDocsInfo, ToJSONPrettyAutoDocsInfo, TokenAutoDocsInfo, TokenMapFileCycleAutoDocsInfo, TokenMapFileNextCycleAutoDocsInfo, TokenMapFileNextTokenAutoDocsInfo, TokenMapFileTokenAutoDocsInfo, ToLocalTimeAutoDocsInfo, ToLongAutoDocsInfo, ToLongAutoDocsInfo, ToLongAutoDocsInfo, ToLongFunctionAutoDocsInfo, ToLongUnaryOperatorAutoDocsInfo, ToMD5ByteBufferAutoDocsInfo, ToMillisAtStartOfDayAutoDocsInfo, ToMillisAtStartOfHourAutoDocsInfo, ToMillisAtStartOfMinuteAutoDocsInfo, ToMillisAtStartOfMonthAutoDocsInfo, ToMillisAtStartOfNamedWeekDayAutoDocsInfo, ToMillisAtStartOfNextDayAutoDocsInfo, ToMillisAtStartOfNextNamedWeekDayAutoDocsInfo, ToMillisAtStartOfSecondAutoDocsInfo, ToMillisAtStartOfYearAutoDocsInfo, ToShortAutoDocsInfo, ToShortAutoDocsInfo, ToShortAutoDocsInfo, ToShortAutoDocsInfo, ToShortAutoDocsInfo, ToStringAutoDocsInfo, ToStringAutoDocsInfo, ToStringAutoDocsInfo, ToStringAutoDocsInfo, ToStringAutoDocsInfo, ToStringAutoDocsInfo, ToTimeUUIDMaxAutoDocsInfo, ToTimeUUIDMinAutoDocsInfo, ToUUIDAutoDocsInfo, ToUUIDAutoDocsInfo, TriangleWaveAutoDocsInfo, TriangleWaveAutoDocsInfo, TriangularAutoDocsInfo, TriangularAutoDocsInfo, TriangularStepAutoDocsInfo, TrimAutoDocsInfo, TypeOfAutoDocsInfo, UniformAutoDocsInfo, UniformAutoDocsInfo, UniformAutoDocsInfo, UniformAutoDocsInfo, UniformAutoDocsInfo, UniformAutoDocsInfo, UniformVectorSizedSteppedAutoDocsInfo, UnsetAutoDocsInfo, UnsetIfCloseToAutoDocsInfo, UnsetIfEmptyAutoDocsInfo, UnsetIfEqAutoDocsInfo, UnsetIfEqAutoDocsInfo, UnsetIfGeAutoDocsInfo, UnsetIfGeAutoDocsInfo, UnsetIfGtAutoDocsInfo, UnsetIfGtAutoDocsInfo, UnsetIfLeAutoDocsInfo, UnsetIfLeAutoDocsInfo, UnsetIfLtAutoDocsInfo, UnsetIfLtAutoDocsInfo, UnsetIfNullOrEmptyAutoDocsInfo, UnsetIfStringEqAutoDocsInfo, UnsetIfStringNeAutoDocsInfo, UnsetIfWithinAutoDocsInfo, UnsetOrLoadAutoDocsInfo, UnsetOrPassAutoDocsInfo, URLDecodeAutoDocsInfo, URLEncodeAutoDocsInfo, WeibullAutoDocsInfo, WeibullAutoDocsInfo, WeightedFuncsAutoDocsInfo, WeightedIntsAutoDocsInfo, WeightedLongsAutoDocsInfo, WeightedStringsAutoDocsInfo, WeightedStringsFromCSVAutoDocsInfo, ZipCodesAutoDocsInfo, ZipCodesByDensityAutoDocsInfo, ZipCodesByPopulationAutoDocsInfo, ZipfAutoDocsInfo, ZipfAutoDocsInfo, ZipfAutoDocsInfo, ZipfAutoDocsInfo

public interface DocFuncData

Provide data about a function, suitable for building a documentation site.

Method Summary

Modifier and Type	Method	Description
Category[]	getCategories()
String	getClassJavadoc()	Javadoc for the class, or null if there is none.
String	getClassName()
List<DocCtorData>	getCtors()	The list of constructors for this documented type.
String	getInType()	The input type for the apply method in the documented function class.
String	getOutType()	The output type for the apply method in the documented function class.
String	getPackageName()

Method Details

getPackageName

String getPackageName()

Returns:

the package name for the documented type

getCategories

Category[] getCategories()

Returns:

Return the categories for this function.

getClassName

String getClassName()

Returns:

the the Class.getSimpleName() of the class element

getClassJavadoc

String getClassJavadoc()

Javadoc for the class, or null if there is none.

Returns:

a String of class javadoc data, or null if none

getInType

String getInType()

The input type for the apply method in the documented function class. Documented function classes must always implement a Java 8 functional interface.

Returns:

the input type name

getOutType

String getOutType()

The output type for the apply method in the documented function class. Documented function classes must always implement a Java 8 functional interface.

Returns:

the output type name

getCtors

List<DocCtorData> getCtors()

The list of constructors for this documented type.

Returns:

a list of constructor models